Class VkVideoEncodeH265RateControlInfoEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
In order to provide H.265-specific stream rate control parameters, add a VkVideoEncodeH265RateControlInfoEXT structure to the pNext chain of the VkVideoEncodeRateControlInfoKHR structure in the pNext chain of the VkVideoCodingControlInfoKHR structure passed to the CmdControlVideoCodingKHR command.
The parameters from this structure act as a guidance for implementations to apply various rate control heuristics.
It is 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 in CmdEncodeVideoKHR. Additionally, it is not required for the video session to be reset if the inferred picture type does not match the actual picture type.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_VIDEO_ENCODE_H265_RATE_CONTROL_INFO_EXTflagsmust be a valid combination ofVkVideoEncodeH265RateControlFlagBitsEXTvalues
Layout
struct VkVideoEncodeH265RateControlInfoEXT {
VkStructureType sType();
void const * pNext();
VkVideoEncodeH265RateControlFlagsEXT flags();
uint32_t gopFrameCount();
uint32_t idrPeriod();
uint32_t consecutiveBFrameCount();
uint32_t subLayerCount();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkVideoEncodeH265RateControlInfoEXTstructs.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
ConstructorsConstructorDescriptionVkVideoEncodeH265RateControlInfoEXT(ByteBuffer container) Creates aVkVideoEncodeH265RateControlInfoEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkVideoEncodeH265RateControlInfoEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkVideoEncodeH265RateControlInfoEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH265RateControlInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH265RateControlInfoEXTinstance 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 newVkVideoEncodeH265RateControlInfoEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkVideoEncodeH265RateControlInfoEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkVideoEncodeH265RateControlInfoEXTinstance for the specified memory address.create(long address, int capacity) Create aVkVideoEncodeH265RateControlInfoEXT.Bufferinstance at the specified memory.createSafe(long address) createSafe(long address, int capacity) intflags()a bitmask ofVkVideoEncodeH265RateControlFlagBitsEXTspecifying H.265 rate control flags.flags(int value) Sets the specified value to theflags()field.intthe number of frames contained within the group of pictures (GOP), starting from an intra frame and until the next intra frame.gopFrameCount(int value) Sets the specified value to thegopFrameCount()field.intthe interval, in terms of number of frames, between two IDR frames.idrPeriod(int value) Sets the specified value to theidrPeriod()field.malloc()Returns a newVkVideoEncodeH265RateControlInfoEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkVideoEncodeH265RateControlInfoEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH265RateControlInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH265RateControlInfoEXTinstance 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 intnsubLayerCount(long struct) Unsafe version ofsubLayerCount().static voidnsubLayerCount(long struct, int value) Unsafe version ofsubLayerCount.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 subLayerCount) 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_H265_RATE_CONTROL_INFO_EXTvalue to thesType()field.intspecifies the number of sub layers enabled in the stream.subLayerCount(int value) Sets the specified value to thesubLayerCount()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. -
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. -
SUBLAYERCOUNT
public static final int SUBLAYERCOUNTThe struct member offsets.
-
-
Constructor Details
-
VkVideoEncodeH265RateControlInfoEXT
Creates aVkVideoEncodeH265RateControlInfoEXTinstance 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<VkVideoEncodeH265RateControlInfoEXT>
-
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 ofVkVideoEncodeH265RateControlFlagBitsEXTspecifying H.265 rate control flags. -
gopFrameCount
public int gopFrameCount()the number of frames contained within the group of pictures (GOP), starting from an intra frame and until the next intra frame. If it is set to 0, the implementation chooses a suitable value. If it is set toUINT32_MAX, the GOP length is treated as infinite. -
idrPeriod
public int idrPeriod()the interval, in terms of number of frames, between two IDR frames. If it is set to 0, the implementation chooses a suitable value. If it is set toUINT32_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. -
subLayerCount
public int subLayerCount()specifies the number of sub layers enabled in the stream. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_VIDEO_ENCODE_H265_RATE_CONTROL_INFO_EXTvalue 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. -
subLayerCount
Sets the specified value to thesubLayerCount()field. -
set
public VkVideoEncodeH265RateControlInfoEXT set(int sType, long pNext, int flags, int gopFrameCount, int idrPeriod, int consecutiveBFrameCount, int subLayerCount) 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 newVkVideoEncodeH265RateControlInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkVideoEncodeH265RateControlInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkVideoEncodeH265RateControlInfoEXTinstance allocated withBufferUtils. -
create
Returns a newVkVideoEncodeH265RateControlInfoEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkVideoEncodeH265RateControlInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkVideoEncodeH265RateControlInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkVideoEncodeH265RateControlInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkVideoEncodeH265RateControlInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkVideoEncodeH265RateControlInfoEXT.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkVideoEncodeH265RateControlInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkVideoEncodeH265RateControlInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkVideoEncodeH265RateControlInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH265RateControlInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkVideoEncodeH265RateControlInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoEncodeH265RateControlInfoEXT.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(). -
nsubLayerCount
public static int nsubLayerCount(long struct) Unsafe version ofsubLayerCount(). -
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. -
nsubLayerCount
public static void nsubLayerCount(long struct, int value) Unsafe version ofsubLayerCount.
-