Class VkVideoEncodeH264RateControlInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
When an instance of this structure is included in the pNext chain of the VkVideoCodingControlInfoKHR structure passed to the CmdControlVideoCodingKHR command, and VkVideoCodingControlInfoKHR::flags includes VIDEO_CODING_CONTROL_ENCODE_RATE_CONTROL_BIT_KHR, the parameters in this structure are used as guidance for the implementation’s rate control algorithm (see Video Coding Control).
If flags includes VIDEO_ENCODE_H264_RATE_CONTROL_ATTEMPT_HRD_COMPLIANCE_BIT_KHR, then the rate control state is reset to an initial state to meet HRD compliance requirements. Otherwise the new rate control state may be applied without a reset depending on the implementation and the specified rate control parameters.
Note
It would be possible to infer the picture type to be used when encoding a frame, on the basis of the values provided for consecutiveBFrameCount, idrPeriod, and gopFrameCount, but this inferred picture type will not be used by implementations to override the picture type provided to the video encode operation.
Valid Usage
- If
VkVideoEncodeH264CapabilitiesKHR::flags, as returned byGetPhysicalDeviceVideoCapabilitiesKHRfor the used video profile, does not includeVIDEO_ENCODE_H264_CAPABILITY_HRD_COMPLIANCE_BIT_KHR, thenflagsmust not containVIDEO_ENCODE_H264_RATE_CONTROL_ATTEMPT_HRD_COMPLIANCE_BIT_KHR - If
flagscontainsVIDEO_ENCODE_H264_RATE_CONTROL_REFERENCE_PATTERN_FLAT_BIT_KHRorVIDEO_ENCODE_H264_RATE_CONTROL_REFERENCE_PATTERN_DYADIC_BIT_KHR, then it must also containVIDEO_ENCODE_H264_RATE_CONTROL_REGULAR_GOP_BIT_KHR - If
flagscontainsVIDEO_ENCODE_H264_RATE_CONTROL_REFERENCE_PATTERN_FLAT_BIT_KHR, then it must not also containVIDEO_ENCODE_H264_RATE_CONTROL_REFERENCE_PATTERN_DYADIC_BIT_KHR - If
flagscontainsVIDEO_ENCODE_H264_RATE_CONTROL_REGULAR_GOP_BIT_KHR, thengopFrameCountmust be greater than 0 - If
idrPeriodis not 0, then it must be greater than or equal togopFrameCount - If
consecutiveBFrameCountis not 0, then it must be less thangopFrameCount
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_INFO_KHRflagsmust be a valid combination ofVkVideoEncodeH264RateControlFlagBitsKHRvalues
Layout
struct VkVideoEncodeH264RateControlInfoKHR {
VkStructureType sType();
void const * pNext();
VkVideoEncodeH264RateControlFlagsKHR flags();
uint32_t gopFrameCount();
uint32_t idrPeriod();
uint32_t consecutiveBFrameCount();
uint32_t temporalLayerCount();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkVideoEncodeH264RateControlInfoKHRstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkVideoEncodeH264RateControlInfoKHR(ByteBuffer container) Creates aVkVideoEncodeH264RateControlInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.intthe number of consecutive B frames between I and/or P frames within the GOP.consecutiveBFrameCount(int value) Sets the specified value to theconsecutiveBFrameCount()field.create()Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkVideoEncodeH264RateControlInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkVideoEncodeH264RateControlInfoKHR.Bufferinstance at the specified memory.static @Nullable VkVideoEncodeH264RateControlInfoKHRcreateSafe(long address) static @Nullable VkVideoEncodeH264RateControlInfoKHR.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkVideoEncodeH264RateControlFlagBitsKHRspecifying H.264 rate control flags.flags(int value) Sets the specified value to theflags()field.intthe number of frames within a group of pictures (GOP) intended to be used by the application.gopFrameCount(int value) Sets the specified value to thegopFrameCount()field.intthe interval, in terms of number of frames, between two IDR frames (see IDR period).idrPeriod(int value) Sets the specified value to theidrPeriod()field.malloc()Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated on the specifiedMemoryStack.static intnconsecutiveBFrameCount(long struct) Unsafe version ofconsecutiveBFrameCount().static voidnconsecutiveBFrameCount(long struct, int value) Unsafe version ofconsecutiveBFrameCount.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static intngopFrameCount(long struct) Unsafe version ofgopFrameCount().static voidngopFrameCount(long struct, int value) Unsafe version ofgopFrameCount.static intnidrPeriod(long struct) Unsafe version ofidrPeriod().static voidnidrPeriod(long struct, int value) Unsafe version ofidrPeriod.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intntemporalLayerCount(long struct) Unsafe version oftemporalLayerCount().static voidntemporalLayerCount(long struct, int value) Unsafe version oftemporalLayerCount.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int flags, int gopFrameCount, int idrPeriod, int consecutiveBFrameCount, int temporalLayerCount) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_INFO_KHRvalue to thesType()field.intspecifies the number of H.264 temporal layers that the application intends to use.temporalLayerCount(int value) Sets the specified value to thetemporalLayerCount()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
GOPFRAMECOUNT
public static final int GOPFRAMECOUNTThe struct member offsets. -
IDRPERIOD
public static final int IDRPERIODThe struct member offsets. -
CONSECUTIVEBFRAMECOUNT
public static final int CONSECUTIVEBFRAMECOUNTThe struct member offsets. -
TEMPORALLAYERCOUNT
public static final int TEMPORALLAYERCOUNTThe struct member offsets.
-
-
Constructor Details
-
VkVideoEncodeH264RateControlInfoKHR
Creates aVkVideoEncodeH264RateControlInfoKHRinstance at the current position of the specifiedByteBuffercontainer. Changes to the buffer's content will be visible to the struct instance and vice versa.The created instance holds a strong reference to the container object.
-
-
Method Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkVideoEncodeH264RateControlInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()a bitmask ofVkVideoEncodeH264RateControlFlagBitsKHRspecifying H.264 rate control flags. -
gopFrameCount
public int gopFrameCount()the number of frames within a group of pictures (GOP) intended to be used by the application. If it is 0, the rate control algorithm may assume an implementation-dependent GOP length. If it isUINT32_MAX, the GOP length is treated as infinite. -
idrPeriod
public int idrPeriod()the interval, in terms of number of frames, between two IDR frames (see IDR period). If it is 0, the rate control algorithm may assume an implementation-dependent IDR period. If it isUINT32_MAX, the IDR period is treated as infinite. -
consecutiveBFrameCount
public int consecutiveBFrameCount()the number of consecutive B frames between I and/or P frames within the GOP. -
temporalLayerCount
public int temporalLayerCount()specifies the number of H.264 temporal layers that the application intends to use. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
gopFrameCount
Sets the specified value to thegopFrameCount()field. -
idrPeriod
Sets the specified value to theidrPeriod()field. -
consecutiveBFrameCount
Sets the specified value to theconsecutiveBFrameCount()field. -
temporalLayerCount
Sets the specified value to thetemporalLayerCount()field. -
set
public VkVideoEncodeH264RateControlInfoKHR set(int sType, long pNext, int flags, int gopFrameCount, int idrPeriod, int consecutiveBFrameCount, int temporalLayerCount) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkVideoEncodeH264RateControlInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkVideoEncodeH264RateControlInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkVideoEncodeH264RateControlInfoKHR.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkVideoEncodeH264RateControlInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkVideoEncodeH264RateControlInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkVideoEncodeH264RateControlInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
ngopFrameCount
public static int ngopFrameCount(long struct) Unsafe version ofgopFrameCount(). -
nidrPeriod
public static int nidrPeriod(long struct) Unsafe version ofidrPeriod(). -
nconsecutiveBFrameCount
public static int nconsecutiveBFrameCount(long struct) Unsafe version ofconsecutiveBFrameCount(). -
ntemporalLayerCount
public static int ntemporalLayerCount(long struct) Unsafe version oftemporalLayerCount(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
ngopFrameCount
public static void ngopFrameCount(long struct, int value) Unsafe version ofgopFrameCount. -
nidrPeriod
public static void nidrPeriod(long struct, int value) Unsafe version ofidrPeriod. -
nconsecutiveBFrameCount
public static void nconsecutiveBFrameCount(long struct, int value) Unsafe version ofconsecutiveBFrameCount. -
ntemporalLayerCount
public static void ntemporalLayerCount(long struct, int value) Unsafe version oftemporalLayerCount.
-