Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoDecodeInfoKHR

extends Struct<VkVideoDecodeInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying video decode parameters.
Valid Usage
Valid Usage (Implicit)
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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkVideoDecodeInfoKHR.Buffer

An array of VkVideoDecodeInfoKHR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DSTPICTURERESOURCE

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PREFERENCESLOTS

The struct member offsets.

public static final int
PSETUPREFERENCESLOT

The struct member offsets.

public static final int
REFERENCESLOTCOUNT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SRCBUFFER

The struct member offsets.

public static final int
SRCBUFFEROFFSET

The struct member offsets.

public static final int
SRCBUFFERRANGE

The struct member offsets.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkVideoDecodeInfoKHR(long address, ByteBuffer container)

public
VkVideoDecodeInfoKHR(ByteBuffer container)

Creates a VkVideoDecodeInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkVideoDecodeInfoKHR
calloc()

Returns a new VkVideoDecodeInfoKHR instance allocated with memCalloc.

public static VkVideoDecodeInfoKHR.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkVideoDecodeInfoKHR.Buffer instance allocated with memCalloc.

public static VkVideoDecodeInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkVideoDecodeInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkVideoDecodeInfoKHR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkVideoDecodeInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected VkVideoDecodeInfoKHR
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkVideoDecodeInfoKHR
create()

Returns a new VkVideoDecodeInfoKHR instance allocated with BufferUtils.

public static VkVideoDecodeInfoKHR
create(long address)

Returns a new VkVideoDecodeInfoKHR instance for the specified memory address.

public static VkVideoDecodeInfoKHR.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkVideoDecodeInfoKHR.Buffer instance allocated with BufferUtils.

public static VkVideoDecodeInfoKHR.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkVideoDecodeInfoKHR.Buffer instance at the specified memory.

public static VkVideoDecodeInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkVideoDecodeInfoKHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public VkVideoPictureResourceInfoKHR
dstPictureResource()

the video picture resource to use as the decode output picture.

public VkVideoDecodeInfoKHR
dstPictureResource(VkVideoPictureResourceInfoKHR value)

Copies the specified VkVideoPictureResourceInfoKHR to the dstPictureResource field.

public VkVideoDecodeInfoKHR
dstPictureResource(Consumer<VkVideoPictureResourceInfoKHR> consumer)

Passes the dstPictureResource field to the specified Consumer.

public int
flags()

reserved for future use.

public VkVideoDecodeInfoKHR
flags(int value)

Sets the specified value to the flags field.

public static VkVideoDecodeInfoKHR
malloc()

Returns a new VkVideoDecodeInfoKHR instance allocated with memAlloc.

public static VkVideoDecodeInfoKHR.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkVideoDecodeInfoKHR.Buffer instance allocated with memAlloc.

public static VkVideoDecodeInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkVideoDecodeInfoKHR instance allocated on the specified MemoryStack.

public static VkVideoDecodeInfoKHR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkVideoDecodeInfoKHR.Buffer instance allocated on the specified MemoryStack.

public static VkVideoPictureResourceInfoKHR
ndstPictureResource(long struct)

Unsafe version of dstPictureResource.

public static void
ndstPictureResource(long struct, VkVideoPictureResourceInfoKHR value)

Unsafe version of dstPictureResource.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkVideoReferenceSlotInfoKHR.Buffer
npReferenceSlots(long struct)

Unsafe version of pReferenceSlots.

public static void
npReferenceSlots(long struct, VkVideoReferenceSlotInfoKHR.Buffer value)

Unsafe version of pReferenceSlots.

public static VkVideoReferenceSlotInfoKHR
npSetupReferenceSlot(long struct)

Unsafe version of pSetupReferenceSlot.

public static void
npSetupReferenceSlot(long struct, VkVideoReferenceSlotInfoKHR value)

Unsafe version of pSetupReferenceSlot.

public static int
nreferenceSlotCount(long struct)

Unsafe version of referenceSlotCount.

public static void
nreferenceSlotCount(long struct, int value)

Sets the specified value to the referenceSlotCount field of the specified struct.

public static long
nsrcBuffer(long struct)

Unsafe version of srcBuffer.

public static void
nsrcBuffer(long struct, long value)

Unsafe version of srcBuffer.

public static long
nsrcBufferOffset(long struct)

Unsafe version of srcBufferOffset.

public static void
nsrcBufferOffset(long struct, long value)

Unsafe version of srcBufferOffset.

public static long
nsrcBufferRange(long struct)

Unsafe version of srcBufferRange.

public static void
nsrcBufferRange(long struct, long value)

Unsafe version of srcBufferRange.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkVideoDecodeInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkVideoDecodeInfoKHR
pNext(VkVideoDecodeH264PictureInfoKHR value)

Prepends the specified VkVideoDecodeH264PictureInfoKHR value to the pNext chain.

public VkVideoDecodeInfoKHR
pNext(VkVideoDecodeH265PictureInfoKHR value)

Prepends the specified VkVideoDecodeH265PictureInfoKHR value to the pNext chain.

public VkVideoReferenceSlotInfoKHR.Buffer
pReferenceSlots()

NULL or a pointer to an array of VkVideoReferenceSlotInfoKHR structures describing the DPB slots and corresponding reference picture resources to use in this video decode operation (the set of active reference pictures).

public VkVideoDecodeInfoKHR
pReferenceSlots(VkVideoReferenceSlotInfoKHR.Buffer value)

Sets the address of the specified VkVideoReferenceSlotInfoKHR.Buffer to the pReferenceSlots field.

public VkVideoReferenceSlotInfoKHR
pSetupReferenceSlot()

NULL or a pointer to a VkVideoReferenceSlotInfoKHR structure describing the DPB slot to activate and the video picture resource to use as the reconstructed picture to activate the DPB slot with.

public VkVideoDecodeInfoKHR
pSetupReferenceSlot(VkVideoReferenceSlotInfoKHR value)

Sets the address of the specified VkVideoReferenceSlotInfoKHR to the pSetupReferenceSlot field.

public int
referenceSlotCount()

the number of elements in the pReferenceSlots array.

public VkVideoDecodeInfoKHR
set(int sType, long pNext, int flags, long srcBuffer, long srcBufferOffset, long srcBufferRange, VkVideoPictureResourceInfoKHR dstPictureResource, VkVideoReferenceSlotInfoKHR pSetupReferenceSlot, VkVideoReferenceSlotInfoKHR.Buffer pReferenceSlots)

Initializes this struct with the specified values.

public VkVideoDecodeInfoKHR

Returns:

this struct
set(VkVideoDecodeInfoKHR
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public long
srcBuffer()

the source video bitstream buffer to read the encoded bitstream from.

public VkVideoDecodeInfoKHR
srcBuffer(long value)

Sets the specified value to the srcBuffer field.

public long
srcBufferOffset()

the starting offset in bytes from the start of srcBuffer to read the encoded bitstream from.

public VkVideoDecodeInfoKHR
srcBufferOffset(long value)

Sets the specified value to the srcBufferOffset field.

public long
srcBufferRange()

the size in bytes of the encoded bitstream to decode from srcBuffer, starting from srcBufferOffset.

public VkVideoDecodeInfoKHR
srcBufferRange(long value)

Sets the specified value to the srcBufferRange field.

public int
sType()

a VkStructureType value identifying this structure.

public VkVideoDecodeInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkVideoDecodeInfoKHR
sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_DECODE_INFO_KHR value to the sType field.

public static void
validate(long
the struct to validate
struct)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate