Package org.lwjgl.vulkan
Class VkVideoCapabilitiesKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkVideoCapabilitiesKHR>
org.lwjgl.vulkan.VkVideoCapabilitiesKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkVideoCapabilitiesKHR
extends org.lwjgl.system.Struct<VkVideoCapabilitiesKHR>
implements org.lwjgl.system.NativeResource
Structure describing general video capabilities for a video profile.
Description
Note
It is common for video compression standards to allow using all reference pictures associated with active DPB slots as active reference pictures, hence for video decode profiles the values returned in maxDpbSlots and maxActiveReferencePictures are often equal. Similarly, in case of video decode profiles supporting field pictures the value of maxActiveReferencePictures often equals maxDpbSlots × 2.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_VIDEO_CAPABILITIES_KHR- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkVideoDecodeAV1CapabilitiesKHR,VkVideoDecodeCapabilitiesKHR,VkVideoDecodeH264CapabilitiesKHR,VkVideoDecodeH265CapabilitiesKHR,VkVideoEncodeAV1CapabilitiesKHR,VkVideoEncodeAV1QuantizationMapCapabilitiesKHR,VkVideoEncodeCapabilitiesKHR,VkVideoEncodeH264CapabilitiesKHR,VkVideoEncodeH264QuantizationMapCapabilitiesKHR,VkVideoEncodeH265CapabilitiesKHR,VkVideoEncodeH265QuantizationMapCapabilitiesKHR, orVkVideoEncodeQuantizationMapCapabilitiesKHR - The
sTypevalue of each struct in thepNextchain must be unique
See Also
VkExtensionProperties, VkExtent2D, GetPhysicalDeviceVideoCapabilitiesKHR
Layout
struct VkVideoCapabilitiesKHR {
VkStructureType sType();
void * pNext();
VkVideoCapabilityFlagsKHR flags();
VkDeviceSize minBitstreamBufferOffsetAlignment();
VkDeviceSize minBitstreamBufferSizeAlignment();
VkExtent2D pictureAccessGranularity();
VkExtent2D minCodedExtent();
VkExtent2D maxCodedExtent();
uint32_t maxDpbSlots();
uint32_t maxActiveReferencePictures();
VkExtensionProperties stdHeaderVersion();
}-
Nested Class Summary
Nested ClassesNested 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 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
ConstructorsConstructorDescriptionVkVideoCapabilitiesKHR(ByteBuffer container) Creates aVkVideoCapabilitiesKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkVideoCapabilitiesKHRcalloc()Returns a newVkVideoCapabilitiesKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkVideoCapabilitiesKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoCapabilitiesKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkVideoCapabilitiesKHRcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoCapabilitiesKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkVideoCapabilitiesKHRcreate()Returns a newVkVideoCapabilitiesKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkVideoCapabilitiesKHR.Bufferinstance allocated withBufferUtils.static VkVideoCapabilitiesKHRcreate(long address) Returns a newVkVideoCapabilitiesKHRinstance for the specified memory address.create(long address, int capacity) Create aVkVideoCapabilitiesKHR.Bufferinstance at the specified memory.static @Nullable VkVideoCapabilitiesKHRcreateSafe(long address) static @Nullable VkVideoCapabilitiesKHR.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkVideoCapabilityFlagBitsKHRspecifying capability flags.static VkVideoCapabilitiesKHRmalloc()Returns a newVkVideoCapabilitiesKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkVideoCapabilitiesKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoCapabilitiesKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkVideoCapabilitiesKHRmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoCapabilitiesKHRinstance allocated on the specifiedMemoryStack.intthe maximum number of active reference pictures a single video coding operation can use.the maximum width and height of the coded frames.intthe maximum number of DPB slots supported by a single video session.longthe minimum alignment for bitstream buffer offsets.longthe minimum alignment for bitstream buffer range sizes.the minimum width and height of the coded frames.static intnflags(long struct) Unsafe version offlags().static intnmaxActiveReferencePictures(long struct) Unsafe version ofmaxActiveReferencePictures().static VkExtent2DnmaxCodedExtent(long struct) Unsafe version ofmaxCodedExtent().static intnmaxDpbSlots(long struct) Unsafe version ofmaxDpbSlots().static longnminBitstreamBufferOffsetAlignment(long struct) Unsafe version ofminBitstreamBufferOffsetAlignment().static longnminBitstreamBufferSizeAlignment(long struct) Unsafe version ofminBitstreamBufferSizeAlignment().static VkExtent2DnminCodedExtent(long struct) Unsafe version ofminCodedExtent().static VkExtent2DnpictureAccessGranularity(long struct) Unsafe version ofpictureAccessGranularity().static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static VkExtensionPropertiesnstdHeaderVersion(long struct) Unsafe version ofstdHeaderVersion().static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.the granularity at which image access to video picture resources happen.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkVideoDecodeAV1CapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoDecodeCapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoDecodeH264CapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoDecodeH265CapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoEncodeAV1CapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoEncodeAV1QuantizationMapCapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoEncodeCapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoEncodeH264CapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoEncodeH264QuantizationMapCapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoEncodeH265CapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoEncodeH265QuantizationMapCapabilitiesKHRvalue to thepNextchain.Prepends the specifiedVkVideoEncodeQuantizationMapCapabilitiesKHRvalue to thepNextchain.set(int sType, long pNext) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()aVkExtensionPropertiesstructure reporting the Video Std header name and version supported for the video profile.intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_VIDEO_CAPABILITIES_KHRvalue to thesType()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. -
MINBITSTREAMBUFFEROFFSETALIGNMENT
public static final int MINBITSTREAMBUFFEROFFSETALIGNMENTThe struct member offsets. -
MINBITSTREAMBUFFERSIZEALIGNMENT
public static final int MINBITSTREAMBUFFERSIZEALIGNMENTThe struct member offsets. -
PICTUREACCESSGRANULARITY
public static final int PICTUREACCESSGRANULARITYThe struct member offsets. -
MINCODEDEXTENT
public static final int MINCODEDEXTENTThe struct member offsets. -
MAXCODEDEXTENT
public static final int MAXCODEDEXTENTThe struct member offsets. -
MAXDPBSLOTS
public static final int MAXDPBSLOTSThe struct member offsets. -
MAXACTIVEREFERENCEPICTURES
public static final int MAXACTIVEREFERENCEPICTURESThe struct member offsets. -
STDHEADERVERSION
public static final int STDHEADERVERSIONThe struct member offsets.
-
-
Constructor Details
-
VkVideoCapabilitiesKHR
Creates aVkVideoCapabilitiesKHRinstance 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<VkVideoCapabilitiesKHR>
-
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 ofVkVideoCapabilityFlagBitsKHRspecifying capability flags. -
minBitstreamBufferOffsetAlignment
public long minBitstreamBufferOffsetAlignment()the minimum alignment for bitstream buffer offsets. -
minBitstreamBufferSizeAlignment
public long minBitstreamBufferSizeAlignment()the minimum alignment for bitstream buffer range sizes. -
pictureAccessGranularity
the granularity at which image access to video picture resources happen. -
minCodedExtent
the minimum width and height of the coded frames. -
maxCodedExtent
the maximum width and height of the coded frames. -
maxDpbSlots
public int maxDpbSlots()the maximum number of DPB slots supported by a single video session. -
maxActiveReferencePictures
public int maxActiveReferencePictures()the maximum number of active reference pictures a single video coding operation can use. -
stdHeaderVersion
aVkExtensionPropertiesstructure reporting the Video Std header name and version supported for the video profile. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_VIDEO_CAPABILITIES_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkVideoDecodeAV1CapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoDecodeCapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoDecodeH264CapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoDecodeH265CapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoEncodeAV1CapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoEncodeAV1QuantizationMapCapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoEncodeCapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoEncodeH264CapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoEncodeH264QuantizationMapCapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoEncodeH265CapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoEncodeH265QuantizationMapCapabilitiesKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoEncodeQuantizationMapCapabilitiesKHRvalue to thepNextchain. -
set
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 newVkVideoCapabilitiesKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkVideoCapabilitiesKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkVideoCapabilitiesKHRinstance allocated withBufferUtils. -
create
Returns a newVkVideoCapabilitiesKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkVideoCapabilitiesKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkVideoCapabilitiesKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkVideoCapabilitiesKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkVideoCapabilitiesKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
malloc
Returns a newVkVideoCapabilitiesKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkVideoCapabilitiesKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkVideoCapabilitiesKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoCapabilitiesKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkVideoCapabilitiesKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoCapabilitiesKHR.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(). -
nminBitstreamBufferOffsetAlignment
public static long nminBitstreamBufferOffsetAlignment(long struct) Unsafe version ofminBitstreamBufferOffsetAlignment(). -
nminBitstreamBufferSizeAlignment
public static long nminBitstreamBufferSizeAlignment(long struct) Unsafe version ofminBitstreamBufferSizeAlignment(). -
npictureAccessGranularity
Unsafe version ofpictureAccessGranularity(). -
nminCodedExtent
Unsafe version ofminCodedExtent(). -
nmaxCodedExtent
Unsafe version ofmaxCodedExtent(). -
nmaxDpbSlots
public static int nmaxDpbSlots(long struct) Unsafe version ofmaxDpbSlots(). -
nmaxActiveReferencePictures
public static int nmaxActiveReferencePictures(long struct) Unsafe version ofmaxActiveReferencePictures(). -
nstdHeaderVersion
Unsafe version ofstdHeaderVersion(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext.
-