Package org.lwjgl.vulkan
Class VkVideoDecodeInfoKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkVideoDecodeInfoKHR>
org.lwjgl.vulkan.VkVideoDecodeInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkVideoDecodeInfoKHR
extends org.lwjgl.system.Struct<VkVideoDecodeInfoKHR>
implements org.lwjgl.system.NativeResource
Structure specifying video decode parameters.
Valid Usage
srcBuffermust have been created withBUFFER_USAGE_VIDEO_DECODE_SRC_BIT_KHRsetsrcBufferOffsetmust be less than the size ofsrcBuffersrcBufferRangemust be less than or equal to the size ofsrcBufferminussrcBufferOffset- If
pSetupReferenceSlotis notNULL, then itsslotIndexmember must not be negative - If
pSetupReferenceSlotis notNULL, then itspPictureResourcemust not beNULL - The
slotIndexmember of each element ofpReferenceSlotsmust not be negative - The
pPictureResourcemember of each element ofpReferenceSlotsmust not beNULL
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_VIDEO_DECODE_INFO_KHR- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkVideoDecodeAV1PictureInfoKHR,VkVideoDecodeH264PictureInfoKHR,VkVideoDecodeH265PictureInfoKHR, orVkVideoInlineQueryInfoKHR - The
sTypevalue of each struct in thepNextchain must be unique flagsmust be 0srcBuffermust be a validVkBufferhandledstPictureResourcemust be a validVkVideoPictureResourceInfoKHRstructure- If
pSetupReferenceSlotis notNULL,pSetupReferenceSlotmust be a valid pointer to a validVkVideoReferenceSlotInfoKHRstructure - If
referenceSlotCountis not 0,pReferenceSlotsmust be a valid pointer to an array ofreferenceSlotCountvalidVkVideoReferenceSlotInfoKHRstructures
See Also
VkVideoPictureResourceInfoKHR, VkVideoReferenceSlotInfoKHR, CmdDecodeVideoKHR
Layout
struct VkVideoDecodeInfoKHR {
VkStructureType sType();
void const * pNext();
VkVideoDecodeFlagsKHR flags();
VkBuffer srcBuffer();
VkDeviceSize srcBufferOffset();
VkDeviceSize srcBufferRange();
VkVideoPictureResourceInfoKHR dstPictureResource();
VkVideoReferenceSlotInfoKHR const * pSetupReferenceSlot();
uint32_t referenceSlotCount();
VkVideoReferenceSlotInfoKHR const * pReferenceSlots();
}-
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 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
ConstructorsConstructorDescriptionVkVideoDecodeInfoKHR(ByteBuffer container) Creates aVkVideoDecodeInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkVideoDecodeInfoKHRcalloc()Returns a newVkVideoDecodeInfoKHRinstance allocated withmemCalloc.static VkVideoDecodeInfoKHR.Buffercalloc(int capacity) Returns a newVkVideoDecodeInfoKHR.Bufferinstance allocated withmemCalloc.static VkVideoDecodeInfoKHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoDecodeInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkVideoDecodeInfoKHRcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoDecodeInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkVideoDecodeInfoKHRcreate()Returns a newVkVideoDecodeInfoKHRinstance allocated withBufferUtils.static VkVideoDecodeInfoKHR.Buffercreate(int capacity) Returns a newVkVideoDecodeInfoKHR.Bufferinstance allocated withBufferUtils.static VkVideoDecodeInfoKHRcreate(long address) Returns a newVkVideoDecodeInfoKHRinstance for the specified memory address.static VkVideoDecodeInfoKHR.Buffercreate(long address, int capacity) Create aVkVideoDecodeInfoKHR.Bufferinstance at the specified memory.static @Nullable VkVideoDecodeInfoKHRcreateSafe(long address) static @Nullable VkVideoDecodeInfoKHR.BuffercreateSafe(long address, int capacity) the video picture resource to use as the decode output picture.Passes thedstPictureResource()field to the specifiedConsumer.Copies the specifiedVkVideoPictureResourceInfoKHRto thedstPictureResource()field.intflags()reserved for future use.flags(int value) Sets the specified value to theflags()field.static VkVideoDecodeInfoKHRmalloc()Returns a newVkVideoDecodeInfoKHRinstance allocated withmemAlloc.static VkVideoDecodeInfoKHR.Buffermalloc(int capacity) Returns a newVkVideoDecodeInfoKHR.Bufferinstance allocated withmemAlloc.static VkVideoDecodeInfoKHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkVideoDecodeInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkVideoDecodeInfoKHRmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkVideoDecodeInfoKHRinstance allocated on the specifiedMemoryStack.ndstPictureResource(long struct) Unsafe version ofdstPictureResource().static voidndstPictureResource(long struct, VkVideoPictureResourceInfoKHR value) Unsafe version ofdstPictureResource.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable VkVideoReferenceSlotInfoKHR.BuffernpReferenceSlots(long struct) Unsafe version ofpReferenceSlots().static voidnpReferenceSlots(long struct, @Nullable VkVideoReferenceSlotInfoKHR.Buffer value) Unsafe version ofpReferenceSlots.static @Nullable VkVideoReferenceSlotInfoKHRnpSetupReferenceSlot(long struct) Unsafe version ofpSetupReferenceSlot().static voidnpSetupReferenceSlot(long struct, @Nullable VkVideoReferenceSlotInfoKHR value) Unsafe version ofpSetupReferenceSlot.static intnreferenceSlotCount(long struct) Unsafe version ofreferenceSlotCount().static voidnreferenceSlotCount(long struct, int value) Sets the specified value to thereferenceSlotCountfield of the specifiedstruct.static longnsrcBuffer(long struct) Unsafe version ofsrcBuffer().static voidnsrcBuffer(long struct, long value) Unsafe version ofsrcBuffer.static longnsrcBufferOffset(long struct) Unsafe version ofsrcBufferOffset().static voidnsrcBufferOffset(long struct, long value) Unsafe version ofsrcBufferOffset.static longnsrcBufferRange(long struct) Unsafe version ofsrcBufferRange().static voidnsrcBufferRange(long struct, long value) Unsafe version ofsrcBufferRange.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkVideoDecodeAV1PictureInfoKHRvalue to thepNextchain.Prepends the specifiedVkVideoDecodeH264PictureInfoKHRvalue to thepNextchain.Prepends the specifiedVkVideoDecodeH265PictureInfoKHRvalue to thepNextchain.pNext(VkVideoInlineQueryInfoKHR value) Prepends the specifiedVkVideoInlineQueryInfoKHRvalue to thepNextchain.@Nullable VkVideoReferenceSlotInfoKHR.BufferNULLor a pointer to an array ofVkVideoReferenceSlotInfoKHRstructures describing the DPB slots and corresponding reference picture resources to use in this video decode operation (the set of active reference pictures).pReferenceSlots(@Nullable VkVideoReferenceSlotInfoKHR.Buffer value) Sets the address of the specifiedVkVideoReferenceSlotInfoKHR.Bufferto thepReferenceSlots()field.@Nullable VkVideoReferenceSlotInfoKHRNULLor a pointer to aVkVideoReferenceSlotInfoKHRstructure specifying the reconstructed picture information.pSetupReferenceSlot(@Nullable VkVideoReferenceSlotInfoKHR value) Sets the address of the specifiedVkVideoReferenceSlotInfoKHRto thepSetupReferenceSlot()field.intthe number of elements in thepReferenceSlotsarray.set(int sType, long pNext, int flags, long srcBuffer, long srcBufferOffset, long srcBufferRange, VkVideoPictureResourceInfoKHR dstPictureResource, @Nullable VkVideoReferenceSlotInfoKHR pSetupReferenceSlot, @Nullable VkVideoReferenceSlotInfoKHR.Buffer pReferenceSlots) Initializes this struct with the specified values.set(VkVideoDecodeInfoKHR src) Copies the specified struct data to this struct.intsizeof()longthe source video bitstream buffer to read the encoded bitstream from.srcBuffer(long value) Sets the specified value to thesrcBuffer()field.longthe starting offset in bytes from the start ofsrcBufferto read the encoded bitstream from.srcBufferOffset(long value) Sets the specified value to thesrcBufferOffset()field.longthe size in bytes of the encoded bitstream to decode fromsrcBuffer, starting fromsrcBufferOffset.srcBufferRange(long value) Sets the specified value to thesrcBufferRange()field.intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_VIDEO_DECODE_INFO_KHRvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.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. -
SRCBUFFER
public static final int SRCBUFFERThe struct member offsets. -
SRCBUFFEROFFSET
public static final int SRCBUFFEROFFSETThe struct member offsets. -
SRCBUFFERRANGE
public static final int SRCBUFFERRANGEThe struct member offsets. -
DSTPICTURERESOURCE
public static final int DSTPICTURERESOURCEThe struct member offsets. -
PSETUPREFERENCESLOT
public static final int PSETUPREFERENCESLOTThe struct member offsets. -
REFERENCESLOTCOUNT
public static final int REFERENCESLOTCOUNTThe struct member offsets. -
PREFERENCESLOTS
public static final int PREFERENCESLOTSThe struct member offsets.
-
-
Constructor Details
-
VkVideoDecodeInfoKHR
Creates aVkVideoDecodeInfoKHRinstance 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<VkVideoDecodeInfoKHR>
-
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. -
srcBuffer
public long srcBuffer()the source video bitstream buffer to read the encoded bitstream from. -
srcBufferOffset
public long srcBufferOffset()the starting offset in bytes from the start ofsrcBufferto read the encoded bitstream from. -
srcBufferRange
public long srcBufferRange()the size in bytes of the encoded bitstream to decode fromsrcBuffer, starting fromsrcBufferOffset. -
dstPictureResource
the video picture resource to use as the decode output picture. -
pSetupReferenceSlot
NULLor a pointer to aVkVideoReferenceSlotInfoKHRstructure specifying the reconstructed picture information. -
referenceSlotCount
public int referenceSlotCount()the number of elements in thepReferenceSlotsarray. -
pReferenceSlots
NULLor a pointer to an array ofVkVideoReferenceSlotInfoKHRstructures describing the DPB slots and corresponding reference picture resources to use in this video decode operation (the set of active reference pictures). -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_VIDEO_DECODE_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkVideoDecodeAV1PictureInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoDecodeH264PictureInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoDecodeH265PictureInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkVideoInlineQueryInfoKHRvalue to thepNextchain. -
flags
Sets the specified value to theflags()field. -
srcBuffer
Sets the specified value to thesrcBuffer()field. -
srcBufferOffset
Sets the specified value to thesrcBufferOffset()field. -
srcBufferRange
Sets the specified value to thesrcBufferRange()field. -
dstPictureResource
Copies the specifiedVkVideoPictureResourceInfoKHRto thedstPictureResource()field. -
dstPictureResource
Passes thedstPictureResource()field to the specifiedConsumer. -
pSetupReferenceSlot
Sets the address of the specifiedVkVideoReferenceSlotInfoKHRto thepSetupReferenceSlot()field. -
pReferenceSlots
Sets the address of the specifiedVkVideoReferenceSlotInfoKHR.Bufferto thepReferenceSlots()field. -
set
public VkVideoDecodeInfoKHR set(int sType, long pNext, int flags, long srcBuffer, long srcBufferOffset, long srcBufferRange, VkVideoPictureResourceInfoKHR dstPictureResource, @Nullable VkVideoReferenceSlotInfoKHR pSetupReferenceSlot, @Nullable VkVideoReferenceSlotInfoKHR.Buffer pReferenceSlots) 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 newVkVideoDecodeInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkVideoDecodeInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkVideoDecodeInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkVideoDecodeInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkVideoDecodeInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkVideoDecodeInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkVideoDecodeInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkVideoDecodeInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
malloc
Returns a newVkVideoDecodeInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkVideoDecodeInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
Returns a newVkVideoDecodeInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
Returns a newVkVideoDecodeInfoKHR.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(). -
nsrcBuffer
public static long nsrcBuffer(long struct) Unsafe version ofsrcBuffer(). -
nsrcBufferOffset
public static long nsrcBufferOffset(long struct) Unsafe version ofsrcBufferOffset(). -
nsrcBufferRange
public static long nsrcBufferRange(long struct) Unsafe version ofsrcBufferRange(). -
ndstPictureResource
Unsafe version ofdstPictureResource(). -
npSetupReferenceSlot
Unsafe version ofpSetupReferenceSlot(). -
nreferenceSlotCount
public static int nreferenceSlotCount(long struct) Unsafe version ofreferenceSlotCount(). -
npReferenceSlots
Unsafe version ofpReferenceSlots(). -
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. -
nsrcBuffer
public static void nsrcBuffer(long struct, long value) Unsafe version ofsrcBuffer. -
nsrcBufferOffset
public static void nsrcBufferOffset(long struct, long value) Unsafe version ofsrcBufferOffset. -
nsrcBufferRange
public static void nsrcBufferRange(long struct, long value) Unsafe version ofsrcBufferRange. -
ndstPictureResource
Unsafe version ofdstPictureResource. -
npSetupReferenceSlot
Unsafe version ofpSetupReferenceSlot. -
nreferenceSlotCount
public static void nreferenceSlotCount(long struct, int value) Sets the specified value to thereferenceSlotCountfield of the specifiedstruct. -
npReferenceSlots
public static void npReferenceSlots(long struct, @Nullable VkVideoReferenceSlotInfoKHR.Buffer value) Unsafe version ofpReferenceSlots. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-