Class VkVideoEncodeAV1GopRemainingFrameInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
Setting useGopRemainingFrames to TRUE and including this structure in the pNext chain of VkVideoBeginCodingInfoKHR is only mandatory if the VkVideoEncodeAV1CapabilitiesKHR::requiresGopRemainingFrames reported for the used video profile is TRUE. However, implementations may use these remaining frame counts, when specified, even when it is not required. In particular, when the application does not use a regular GOP structure, these values may provide additional guidance for the implementation’s rate control algorithm.
The VkVideoEncodeAV1CapabilitiesKHR::prefersGopRemainingFrames capability is also used to indicate that the implementation’s rate control algorithm may operate more accurately if the application specifies the remaining frame counts using this structure.
As with other rate control guidance values, if the effective order and number of frames encoded by the application are not in line with the remaining frame counts specified in this structure at any given point, then the behavior of the implementation’s rate control algorithm may deviate from the one expected by the application.
Valid Usage (Implicit)
Layout
struct VkVideoEncodeAV1GopRemainingFrameInfoKHR {
VkStructureType sType();
void const * pNext();
VkBool32 useGopRemainingFrames();
uint32_t gopRemainingIntra();
uint32_t gopRemainingPredictive();
uint32_t gopRemainingBipredictive();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkVideoEncodeAV1GopRemainingFrameInfoKHRstructs.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.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionCreates aVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance at the specified memory.static @Nullable VkVideoEncodeAV1GopRemainingFrameInfoKHRcreateSafe(long address) static @Nullable VkVideoEncodeAV1GopRemainingFrameInfoKHR.BuffercreateSafe(long address, int capacity) intspecifies the number of frames encoded withVIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_BIPREDICTIVE_KHRthe implementation’s rate control algorithm should assume to be remaining in the GOP prior to executing the next video encode operation.gopRemainingBipredictive(int value) Sets the specified value to thegopRemainingBipredictive()field.intspecifies the number of frames encoded withVIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_INTRA_KHRthe implementation’s rate control algorithm should assume to be remaining in the GOP prior to executing the next video encode operation.gopRemainingIntra(int value) Sets the specified value to thegopRemainingIntra()field.intspecifies the number of frames encoded withVIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_PREDICTIVE_KHRthe implementation’s rate control algorithm should assume to be remaining in the GOP prior to executing the next video encode operation.gopRemainingPredictive(int value) Sets the specified value to thegopRemainingPredictive()field.malloc()Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated on the specifiedMemoryStack.static intngopRemainingBipredictive(long struct) Unsafe version ofgopRemainingBipredictive().static voidngopRemainingBipredictive(long struct, int value) Unsafe version ofgopRemainingBipredictive.static intngopRemainingIntra(long struct) Unsafe version ofgopRemainingIntra().static voidngopRemainingIntra(long struct, int value) Unsafe version ofgopRemainingIntra.static intngopRemainingPredictive(long struct) Unsafe version ofgopRemainingPredictive().static voidngopRemainingPredictive(long struct, int value) Unsafe version ofgopRemainingPredictive.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 intnuseGopRemainingFrames(long struct) Unsafe version ofuseGopRemainingFrames().static voidnuseGopRemainingFrames(long struct, int value) Unsafe version ofuseGopRemainingFrames.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 useGopRemainingFrames, int gopRemainingIntra, int gopRemainingPredictive, int gopRemainingBipredictive) 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_AV1_GOP_REMAINING_FRAME_INFO_KHRvalue to thesType()field.booleanindicates whether the implementation’s rate control algorithm should use the values specified ingopRemainingIntra,gopRemainingPredictive, andgopRemainingBipredictive.useGopRemainingFrames(boolean value) Sets the specified value to theuseGopRemainingFrames()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. -
USEGOPREMAININGFRAMES
public static final int USEGOPREMAININGFRAMESThe struct member offsets. -
GOPREMAININGINTRA
public static final int GOPREMAININGINTRAThe struct member offsets. -
GOPREMAININGPREDICTIVE
public static final int GOPREMAININGPREDICTIVEThe struct member offsets. -
GOPREMAININGBIPREDICTIVE
public static final int GOPREMAININGBIPREDICTIVEThe struct member offsets.
-
-
Constructor Details
-
VkVideoEncodeAV1GopRemainingFrameInfoKHR
Creates aVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance 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<VkVideoEncodeAV1GopRemainingFrameInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
useGopRemainingFrames
public boolean useGopRemainingFrames()indicates whether the implementation’s rate control algorithm should use the values specified ingopRemainingIntra,gopRemainingPredictive, andgopRemainingBipredictive. IfuseGopRemainingFramesisFALSE, then the values ofgopRemainingIntra,gopRemainingPredictive, andgopRemainingBipredictiveare ignored. -
gopRemainingIntra
public int gopRemainingIntra()specifies the number of frames encoded withVIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_INTRA_KHRthe implementation’s rate control algorithm should assume to be remaining in the GOP prior to executing the next video encode operation. -
gopRemainingPredictive
public int gopRemainingPredictive()specifies the number of frames encoded withVIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_PREDICTIVE_KHRthe implementation’s rate control algorithm should assume to be remaining in the GOP prior to executing the next video encode operation. -
gopRemainingBipredictive
public int gopRemainingBipredictive()specifies the number of frames encoded withVIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_BIPREDICTIVE_KHRthe implementation’s rate control algorithm should assume to be remaining in the GOP prior to executing the next video encode operation. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_VIDEO_ENCODE_AV1_GOP_REMAINING_FRAME_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
useGopRemainingFrames
Sets the specified value to theuseGopRemainingFrames()field. -
gopRemainingIntra
Sets the specified value to thegopRemainingIntra()field. -
gopRemainingPredictive
Sets the specified value to thegopRemainingPredictive()field. -
gopRemainingBipredictive
Sets the specified value to thegopRemainingBipredictive()field. -
set
public VkVideoEncodeAV1GopRemainingFrameInfoKHR set(int sType, long pNext, boolean useGopRemainingFrames, int gopRemainingIntra, int gopRemainingPredictive, int gopRemainingBipredictive) 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 newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkVideoEncodeAV1GopRemainingFrameInfoKHR.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkVideoEncodeAV1GopRemainingFrameInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkVideoEncodeAV1GopRemainingFrameInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeAV1GopRemainingFrameInfoKHR.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(). -
nuseGopRemainingFrames
public static int nuseGopRemainingFrames(long struct) Unsafe version ofuseGopRemainingFrames(). -
ngopRemainingIntra
public static int ngopRemainingIntra(long struct) Unsafe version ofgopRemainingIntra(). -
ngopRemainingPredictive
public static int ngopRemainingPredictive(long struct) Unsafe version ofgopRemainingPredictive(). -
ngopRemainingBipredictive
public static int ngopRemainingBipredictive(long struct) Unsafe version ofgopRemainingBipredictive(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nuseGopRemainingFrames
public static void nuseGopRemainingFrames(long struct, int value) Unsafe version ofuseGopRemainingFrames. -
ngopRemainingIntra
public static void ngopRemainingIntra(long struct, int value) Unsafe version ofgopRemainingIntra. -
ngopRemainingPredictive
public static void ngopRemainingPredictive(long struct, int value) Unsafe version ofgopRemainingPredictive. -
ngopRemainingBipredictive
public static void ngopRemainingBipredictive(long struct, int value) Unsafe version ofgopRemainingBipredictive.
-