Class VkVideoEncodeH264RateControlLayerInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
When used, the values in minQp and maxQp guarantee that the effective QP values used by the implementation will respect those lower and upper bounds, respectively. However, limiting the range of QP values that the implementation is able to use will also limit the capabilities of the implementation’s rate control algorithm to comply to other constraints. In particular, the implementation may not be able to comply to the following:
- The average and/or peak bitrate values to be used for the encoded bitstream specified in the
averageBitrateandmaxBitratemembers of theVkVideoEncodeRateControlLayerInfoKHRstructure. - The upper bounds on the encoded frame size, for each picture type, specified in the
maxFrameSizemember ofVkVideoEncodeH264RateControlLayerInfoKHR.
Note
In general, applications need to configure rate control parameters appropriately in order to be able to get the desired rate control behavior, as described in the Video Encode Rate Control section.
When an instance of this structure is included in the pNext chain of a VkVideoEncodeRateControlLayerInfoKHR structure specified in one of the elements of the pLayers array member of the VkVideoEncodeRateControlInfoKHR structure passed to the CmdControlVideoCodingKHR command, VkVideoCodingControlInfoKHR::flags includes VIDEO_CODING_CONTROL_ENCODE_RATE_CONTROL_BIT_KHR, and the bound video session was created with the video codec operation VIDEO_CODEC_OPERATION_ENCODE_H264_BIT_KHR, it specifies the H.264-specific rate control parameters of the rate control layer corresponding to that element of pLayers.
Valid Usage
- If
useMinQpisTRUE, then theqpI,qpP, andqpBmembers ofminQpmust all be betweenVkVideoEncodeH264CapabilitiesKHR::minQpandVkVideoEncodeH264CapabilitiesKHR::maxQp, as returned byGetPhysicalDeviceVideoCapabilitiesKHRfor the used video profile - If
useMaxQpisTRUE, then theqpI,qpP, andqpBmembers ofmaxQpmust all be betweenVkVideoEncodeH264CapabilitiesKHR::minQpandVkVideoEncodeH264CapabilitiesKHR::maxQp, as returned byGetPhysicalDeviceVideoCapabilitiesKHRfor the used video profile - If
useMinQpisTRUEandVkVideoEncodeH264CapabilitiesKHR::flags, as returned byGetPhysicalDeviceVideoCapabilitiesKHRfor the used video profile, does not includeVIDEO_ENCODE_H264_CAPABILITY_PER_PICTURE_TYPE_MIN_MAX_QP_BIT_KHR, then theqpI,qpP, andqpBmembers ofminQpmust all specify the same value - If
useMaxQpisTRUEandVkVideoEncodeH264CapabilitiesKHR::flags, as returned byGetPhysicalDeviceVideoCapabilitiesKHRfor the used video profile, does not includeVIDEO_ENCODE_H264_CAPABILITY_PER_PICTURE_TYPE_MIN_MAX_QP_BIT_KHR, then theqpI,qpP, andqpBmembers ofmaxQpmust all specify the same value - If
useMinQpanduseMaxQpare bothTRUE, then theqpI,qpP, andqpBmembers ofminQpmust all be less than or equal to the respective members ofmaxQp
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_LAYER_INFO_KHRminQpmust be a validVkVideoEncodeH264QpKHRstructuremaxQpmust be a validVkVideoEncodeH264QpKHRstructuremaxFrameSizemust be a validVkVideoEncodeH264FrameSizeKHRstructure
See Also
VkVideoEncodeH264FrameSizeKHR, VkVideoEncodeH264QpKHR
Layout
struct VkVideoEncodeH264RateControlLayerInfoKHR {
VkStructureType sType();
void const * pNext();
VkBool32 useMinQp();
VkVideoEncodeH264QpKHR minQp();
VkBool32 useMaxQp();
VkVideoEncodeH264QpKHR maxQp();
VkBool32 useMaxFrameSize();
VkVideoEncodeH264FrameSizeKHR maxFrameSize();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkVideoEncodeH264RateControlLayerInfoKHRstructs.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 size 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.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionCreates aVkVideoEncodeH264RateControlLayerInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance at the specified memory.static @Nullable VkVideoEncodeH264RateControlLayerInfoKHRcreateSafe(long address) static @Nullable VkVideoEncodeH264RateControlLayerInfoKHR.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated on the specifiedMemoryStack.specifies the upper bounds on the encoded frame size, for each picture type, whenuseMaxFrameSizeisTRUE.maxFrameSize(Consumer<VkVideoEncodeH264FrameSizeKHR> consumer) Passes themaxFrameSize()field to the specifiedConsumer.Copies the specifiedVkVideoEncodeH264FrameSizeKHRto themaxFrameSize()field.maxQp()specifies the upper bounds on the QP values, for each picture type, that the implementation’s rate control algorithm will use whenuseMaxQpisTRUE.maxQp(Consumer<VkVideoEncodeH264QpKHR> consumer) maxQp(VkVideoEncodeH264QpKHR value) Copies the specifiedVkVideoEncodeH264QpKHRto themaxQp()field.minQp()specifies the lower bounds on the QP values, for each picture type, that the implementation’s rate control algorithm will use whenuseMinQpisTRUE.minQp(Consumer<VkVideoEncodeH264QpKHR> consumer) minQp(VkVideoEncodeH264QpKHR value) Copies the specifiedVkVideoEncodeH264QpKHRto theminQp()field.nmaxFrameSize(long struct) Unsafe version ofmaxFrameSize().static voidnmaxFrameSize(long struct, VkVideoEncodeH264FrameSizeKHR value) Unsafe version ofmaxFrameSize.static VkVideoEncodeH264QpKHRnmaxQp(long struct) Unsafe version ofmaxQp().static voidnmaxQp(long struct, VkVideoEncodeH264QpKHR value) Unsafe version ofmaxQp.static VkVideoEncodeH264QpKHRnminQp(long struct) Unsafe version ofminQp().static voidnminQp(long struct, VkVideoEncodeH264QpKHR value) Unsafe version ofminQp.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 intnuseMaxFrameSize(long struct) Unsafe version ofuseMaxFrameSize().static voidnuseMaxFrameSize(long struct, int value) Unsafe version ofuseMaxFrameSize.static intnuseMaxQp(long struct) Unsafe version ofuseMaxQp().static voidnuseMaxQp(long struct, int value) Unsafe version ofuseMaxQp.static intnuseMinQp(long struct) Unsafe version ofuseMinQp().static voidnuseMinQp(long struct, int value) Unsafe version ofuseMinQp.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, boolean useMinQp, VkVideoEncodeH264QpKHR minQp, boolean useMaxQp, VkVideoEncodeH264QpKHR maxQp, boolean useMaxFrameSize, VkVideoEncodeH264FrameSizeKHR maxFrameSize) 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_LAYER_INFO_KHRvalue to thesType()field.booleanindicates whether the implementation’s rate control algorithm should use the values specified inmaxFrameSizeas the upper bounds on the encoded frame size for each picture type.useMaxFrameSize(boolean value) Sets the specified value to theuseMaxFrameSize()field.booleanuseMaxQp()indicates whether the QP values determined by rate control will be clamped to the upper bounds on the QP values specified inmaxQp.useMaxQp(boolean value) Sets the specified value to theuseMaxQp()field.booleanuseMinQp()indicates whether the QP values determined by rate control will be clamped to the lower bounds on the QP values specified inminQp.useMinQp(boolean value) Sets the specified value to theuseMinQp()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. -
USEMINQP
public static final int USEMINQPThe struct member offsets. -
MINQP
public static final int MINQPThe struct member offsets. -
USEMAXQP
public static final int USEMAXQPThe struct member offsets. -
MAXQP
public static final int MAXQPThe struct member offsets. -
USEMAXFRAMESIZE
public static final int USEMAXFRAMESIZEThe struct member offsets. -
MAXFRAMESIZE
public static final int MAXFRAMESIZEThe struct member offsets.
-
-
Constructor Details
-
VkVideoEncodeH264RateControlLayerInfoKHR
Creates aVkVideoEncodeH264RateControlLayerInfoKHRinstance 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<VkVideoEncodeH264RateControlLayerInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
useMinQp
public boolean useMinQp()indicates whether the QP values determined by rate control will be clamped to the lower bounds on the QP values specified inminQp. -
minQp
specifies the lower bounds on the QP values, for each picture type, that the implementation’s rate control algorithm will use whenuseMinQpisTRUE. -
useMaxQp
public boolean useMaxQp()indicates whether the QP values determined by rate control will be clamped to the upper bounds on the QP values specified inmaxQp. -
maxQp
specifies the upper bounds on the QP values, for each picture type, that the implementation’s rate control algorithm will use whenuseMaxQpisTRUE. -
useMaxFrameSize
public boolean useMaxFrameSize()indicates whether the implementation’s rate control algorithm should use the values specified inmaxFrameSizeas the upper bounds on the encoded frame size for each picture type. -
maxFrameSize
specifies the upper bounds on the encoded frame size, for each picture type, whenuseMaxFrameSizeisTRUE. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_LAYER_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
useMinQp
Sets the specified value to theuseMinQp()field. -
minQp
Copies the specifiedVkVideoEncodeH264QpKHRto theminQp()field. -
minQp
-
useMaxQp
Sets the specified value to theuseMaxQp()field. -
maxQp
Copies the specifiedVkVideoEncodeH264QpKHRto themaxQp()field. -
maxQp
-
useMaxFrameSize
Sets the specified value to theuseMaxFrameSize()field. -
maxFrameSize
Copies the specifiedVkVideoEncodeH264FrameSizeKHRto themaxFrameSize()field. -
maxFrameSize
public VkVideoEncodeH264RateControlLayerInfoKHR maxFrameSize(Consumer<VkVideoEncodeH264FrameSizeKHR> consumer) Passes themaxFrameSize()field to the specifiedConsumer. -
set
public VkVideoEncodeH264RateControlLayerInfoKHR set(int sType, long pNext, boolean useMinQp, VkVideoEncodeH264QpKHR minQp, boolean useMaxQp, VkVideoEncodeH264QpKHR maxQp, boolean useMaxFrameSize, VkVideoEncodeH264FrameSizeKHR maxFrameSize) 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 newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkVideoEncodeH264RateControlLayerInfoKHR.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkVideoEncodeH264RateControlLayerInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkVideoEncodeH264RateControlLayerInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkVideoEncodeH264RateControlLayerInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH264RateControlLayerInfoKHR.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(). -
nuseMinQp
public static int nuseMinQp(long struct) Unsafe version ofuseMinQp(). -
nminQp
Unsafe version ofminQp(). -
nuseMaxQp
public static int nuseMaxQp(long struct) Unsafe version ofuseMaxQp(). -
nmaxQp
Unsafe version ofmaxQp(). -
nuseMaxFrameSize
public static int nuseMaxFrameSize(long struct) Unsafe version ofuseMaxFrameSize(). -
nmaxFrameSize
Unsafe version ofmaxFrameSize(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nuseMinQp
public static void nuseMinQp(long struct, int value) Unsafe version ofuseMinQp. -
nminQp
Unsafe version ofminQp. -
nuseMaxQp
public static void nuseMaxQp(long struct, int value) Unsafe version ofuseMaxQp. -
nmaxQp
Unsafe version ofmaxQp. -
nuseMaxFrameSize
public static void nuseMaxFrameSize(long struct, int value) Unsafe version ofuseMaxFrameSize. -
nmaxFrameSize
Unsafe version ofmaxFrameSize.
-