Class VkVideoEncodeRateControlInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
Including this structure in the pNext chain of VkVideoCodingControlInfoKHR and including VIDEO_CODING_CONTROL_ENCODE_RATE_CONTROL_BIT_KHR in VkVideoCodingControlInfoKHR::flags will define stream rate control settings for video encoding.
Additional structures providing codec-specific rate control parameters may need to be included in the pNext chain of VkVideoCodingControlInfoKHR depending on the codec profile the bound video session was created with and the parameters specified in VkVideoEncodeRateControlInfoKHR (see Video Coding Control).
To ensure that the video session is properly initialized with stream-level rate control settings, the application must call CmdControlVideoCodingKHR with stream-level rate control settings at least once in execution order before the first CmdEncodeVideoKHR command that is executed after video session reset. If not provided, default implementation-specific stream rate control settings will be used.
Stream rate control settings can also be re-initialized during an active video encoding session. The re-initialization takes effect whenever the VkVideoEncodeRateControlInfoKHR structure is included in the pNext chain of the VkVideoCodingControlInfoKHR structure in the call to CmdControlVideoCodingKHR, and only impacts CmdEncodeVideoKHR operations that follow in execution order.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHRflagsmust be 0- If
rateControlModeis not 0,rateControlModemust be a validVkVideoEncodeRateControlModeFlagBitsKHRvalue - If
layerCountis not 0,pLayersmust be a valid pointer to an array oflayerCountvalidVkVideoEncodeRateControlLayerInfoKHRstructures
See Also
VkVideoEncodeRateControlLayerInfoKHR
Layout
struct VkVideoEncodeRateControlInfoKHR {
VkStructureType sType();
void const * pNext();
VkVideoEncodeRateControlFlagsKHR flags();
VkVideoEncodeRateControlModeFlagBitsKHR rateControlMode();
uint32_t layerCount();
VkVideoEncodeRateControlLayerInfoKHR const * pLayers();
uint32_t virtualBufferSizeInMs();
uint32_t initialVirtualBufferSizeInMs();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkVideoEncodeRateControlInfoKHRstructs.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 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
ConstructorsConstructorDescriptionVkVideoEncodeRateControlInfoKHR(ByteBuffer container) Creates aVkVideoEncodeRateControlInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkVideoEncodeRateControlInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkVideoEncodeRateControlInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeRateControlInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeRateControlInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkVideoEncodeRateControlInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkVideoEncodeRateControlInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkVideoEncodeRateControlInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkVideoEncodeRateControlInfoKHR.Bufferinstance at the specified memory.createSafe(long address) createSafe(long address, int capacity) intflags()reserved for future use.flags(int value) Sets the specified value to theflags()field.intthe initial occupancy in milliseconds of the virtual buffer in the leaky bucket model.initialVirtualBufferSizeInMs(int value) Sets the specified value to theinitialVirtualBufferSizeInMs()field.intspecifies the number of rate control layers in the video encode stream.malloc()Returns a newVkVideoEncodeRateControlInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkVideoEncodeRateControlInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeRateControlInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeRateControlInfoKHRinstance allocated on the specifiedMemoryStack.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static intninitialVirtualBufferSizeInMs(long struct) Unsafe version ofinitialVirtualBufferSizeInMs().static voidninitialVirtualBufferSizeInMs(long struct, int value) Unsafe version ofinitialVirtualBufferSizeInMs.static intnlayerCount(long struct) Unsafe version oflayerCount().static voidnlayerCount(long struct, int value) Sets the specified value to thelayerCountfield of the specifiedstruct.npLayers(long struct) Unsafe version ofpLayers().static voidnpLayers(long struct, VkVideoEncodeRateControlLayerInfoKHR.Buffer value) Unsafe version ofpLayers.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnrateControlMode(long struct) Unsafe version ofrateControlMode().static voidnrateControlMode(long struct, int value) Unsafe version ofrateControlMode.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intnvirtualBufferSizeInMs(long struct) Unsafe version ofvirtualBufferSizeInMs().static voidnvirtualBufferSizeInMs(long struct, int value) Unsafe version ofvirtualBufferSizeInMs.pLayers()a pointer to an array ofVkVideoEncodeRateControlLayerInfoKHRstructures specifying the rate control configurations oflayerCountrate control layers.Sets the address of the specifiedVkVideoEncodeRateControlLayerInfoKHR.Bufferto thepLayers()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.intaVkVideoEncodeRateControlModeFlagBitsKHRvalue specifying the encode stream rate control mode.rateControlMode(int value) Sets the specified value to therateControlMode()field.set(int sType, long pNext, int flags, int rateControlMode, VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayers, int virtualBufferSizeInMs, int initialVirtualBufferSizeInMs) 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_RATE_CONTROL_INFO_KHRvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.intthe leaky bucket model virtual buffer size in milliseconds, with respect to peak bitrate.virtualBufferSizeInMs(int value) Sets the specified value to thevirtualBufferSizeInMs()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, 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. -
RATECONTROLMODE
public static final int RATECONTROLMODEThe struct member offsets. -
LAYERCOUNT
public static final int LAYERCOUNTThe struct member offsets. -
PLAYERS
public static final int PLAYERSThe struct member offsets. -
VIRTUALBUFFERSIZEINMS
public static final int VIRTUALBUFFERSIZEINMSThe struct member offsets. -
INITIALVIRTUALBUFFERSIZEINMS
public static final int INITIALVIRTUALBUFFERSIZEINMSThe struct member offsets.
-
-
Constructor Details
-
VkVideoEncodeRateControlInfoKHR
Creates aVkVideoEncodeRateControlInfoKHRinstance 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<VkVideoEncodeRateControlInfoKHR>
-
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()reserved for future use. -
rateControlMode
public int rateControlMode()aVkVideoEncodeRateControlModeFlagBitsKHRvalue specifying the encode stream rate control mode. -
layerCount
public int layerCount()specifies the number of rate control layers in the video encode stream. -
pLayers
a pointer to an array ofVkVideoEncodeRateControlLayerInfoKHRstructures specifying the rate control configurations oflayerCountrate control layers. -
virtualBufferSizeInMs
public int virtualBufferSizeInMs()the leaky bucket model virtual buffer size in milliseconds, with respect to peak bitrate. Valid when rate control mode isVIDEO_ENCODE_RATE_CONTROL_MODE_CBR_BIT_KHRorVIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR. For example, virtual buffer size is (virtualBufferSizeInMs×maxBitrate/ 1000). -
initialVirtualBufferSizeInMs
public int initialVirtualBufferSizeInMs()the initial occupancy in milliseconds of the virtual buffer in the leaky bucket model. Valid when rate control mode isVIDEO_ENCODE_RATE_CONTROL_MODE_CBR_BIT_KHRorVIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
rateControlMode
Sets the specified value to therateControlMode()field. -
pLayers
public VkVideoEncodeRateControlInfoKHR pLayers(@Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer value) Sets the address of the specifiedVkVideoEncodeRateControlLayerInfoKHR.Bufferto thepLayers()field. -
virtualBufferSizeInMs
Sets the specified value to thevirtualBufferSizeInMs()field. -
initialVirtualBufferSizeInMs
Sets the specified value to theinitialVirtualBufferSizeInMs()field. -
set
public VkVideoEncodeRateControlInfoKHR set(int sType, long pNext, int flags, int rateControlMode, @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayers, int virtualBufferSizeInMs, int initialVirtualBufferSizeInMs) 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 newVkVideoEncodeRateControlInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkVideoEncodeRateControlInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkVideoEncodeRateControlInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkVideoEncodeRateControlInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkVideoEncodeRateControlInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkVideoEncodeRateControlInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkVideoEncodeRateControlInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkVideoEncodeRateControlInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkVideoEncodeRateControlInfoKHR.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkVideoEncodeRateControlInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkVideoEncodeRateControlInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkVideoEncodeRateControlInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeRateControlInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkVideoEncodeRateControlInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeRateControlInfoKHR.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(). -
nrateControlMode
public static int nrateControlMode(long struct) Unsafe version ofrateControlMode(). -
nlayerCount
public static int nlayerCount(long struct) Unsafe version oflayerCount(). -
npLayers
Unsafe version ofpLayers(). -
nvirtualBufferSizeInMs
public static int nvirtualBufferSizeInMs(long struct) Unsafe version ofvirtualBufferSizeInMs(). -
ninitialVirtualBufferSizeInMs
public static int ninitialVirtualBufferSizeInMs(long struct) Unsafe version ofinitialVirtualBufferSizeInMs(). -
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. -
nrateControlMode
public static void nrateControlMode(long struct, int value) Unsafe version ofrateControlMode. -
nlayerCount
public static void nlayerCount(long struct, int value) Sets the specified value to thelayerCountfield of the specifiedstruct. -
npLayers
public static void npLayers(long struct, @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer value) Unsafe version ofpLayers. -
nvirtualBufferSizeInMs
public static void nvirtualBufferSizeInMs(long struct, int value) Unsafe version ofvirtualBufferSizeInMs. -
ninitialVirtualBufferSizeInMs
public static void ninitialVirtualBufferSizeInMs(long struct, int value) Unsafe version ofinitialVirtualBufferSizeInMs. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-