Package org.lwjgl.vulkan

Class VkVideoReferenceSlotInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoReferenceSlotInfoKHR>

org.lwjgl.vulkan.VkVideoReferenceSlotInfoKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkVideoReferenceSlotInfoKHR
extends org.lwjgl.system.Struct<VkVideoReferenceSlotInfoKHR>
implements org.lwjgl.system.NativeResource

Structure specifying information about a reference picture slot.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_REFERENCE_SLOT_INFO_KHR
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkVideoDecodeAV1DpbSlotInfoKHR, VkVideoDecodeH264DpbSlotInfoKHR, VkVideoDecodeH265DpbSlotInfoKHR, VkVideoEncodeAV1DpbSlotInfoKHR, VkVideoEncodeH264DpbSlotInfoKHR, or VkVideoEncodeH265DpbSlotInfoKHR
• The sType value of each struct in the pNext chain must be unique
• If pPictureResource is not NULL, pPictureResource must be a valid pointer to a valid VkVideoPictureResourceInfoKHR structure

See Also

VkVideoBeginCodingInfoKHR, VkVideoDecodeInfoKHR, VkVideoEncodeInfoKHR, VkVideoPictureResourceInfoKHR

Layout

 struct VkVideoReferenceSlotInfoKHR {
     VkStructureType sType();
     void const * pNext();
     int32_t slotIndex();
     VkVideoPictureResourceInfoKHR const * pPictureResource();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoReferenceSlotInfoKHR.Buffer	An array of VkVideoReferenceSlotInfoKHR structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	PPICTURERESOURCE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SLOTINDEX	The struct member offsets.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkVideoReferenceSlotInfoKHR(ByteBuffer container)	Creates a VkVideoReferenceSlotInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoReferenceSlotInfoKHR	calloc()	Returns a new VkVideoReferenceSlotInfoKHR instance allocated with memCalloc.
static VkVideoReferenceSlotInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoReferenceSlotInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoReferenceSlotInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoReferenceSlotInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoReferenceSlotInfoKHR	create()	Returns a new VkVideoReferenceSlotInfoKHR instance allocated with BufferUtils.
static VkVideoReferenceSlotInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoReferenceSlotInfoKHR	create(long address)	Returns a new VkVideoReferenceSlotInfoKHR instance for the specified memory address.
static VkVideoReferenceSlotInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoReferenceSlotInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoReferenceSlotInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoReferenceSlotInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoReferenceSlotInfoKHR	malloc()	Returns a new VkVideoReferenceSlotInfoKHR instance allocated with memAlloc.
static VkVideoReferenceSlotInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoReferenceSlotInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoReferenceSlotInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoReferenceSlotInfoKHR instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable VkVideoPictureResourceInfoKHR	npPictureResource(long struct)	Unsafe version of pPictureResource().
static void	npPictureResource(long struct, @Nullable VkVideoPictureResourceInfoKHR value)	Unsafe version of pPictureResource.
static int	nslotIndex(long struct)	Unsafe version of slotIndex().
static void	nslotIndex(long struct, int value)	Unsafe version of slotIndex.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoReferenceSlotInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoReferenceSlotInfoKHR	pNext(VkVideoDecodeAV1DpbSlotInfoKHR value)	Prepends the specified VkVideoDecodeAV1DpbSlotInfoKHR value to the pNext chain.
VkVideoReferenceSlotInfoKHR	pNext(VkVideoDecodeH264DpbSlotInfoKHR value)	Prepends the specified VkVideoDecodeH264DpbSlotInfoKHR value to the pNext chain.
VkVideoReferenceSlotInfoKHR	pNext(VkVideoDecodeH265DpbSlotInfoKHR value)	Prepends the specified VkVideoDecodeH265DpbSlotInfoKHR value to the pNext chain.
VkVideoReferenceSlotInfoKHR	pNext(VkVideoEncodeAV1DpbSlotInfoKHR value)	Prepends the specified VkVideoEncodeAV1DpbSlotInfoKHR value to the pNext chain.
VkVideoReferenceSlotInfoKHR	pNext(VkVideoEncodeH264DpbSlotInfoKHR value)	Prepends the specified VkVideoEncodeH264DpbSlotInfoKHR value to the pNext chain.
VkVideoReferenceSlotInfoKHR	pNext(VkVideoEncodeH265DpbSlotInfoKHR value)	Prepends the specified VkVideoEncodeH265DpbSlotInfoKHR value to the pNext chain.
@Nullable VkVideoPictureResourceInfoKHR	pPictureResource()	NULL or a pointer to a VkVideoPictureResourceInfoKHR structure describing the video picture resource associated with the DPB slot index specified by slotIndex.
VkVideoReferenceSlotInfoKHR	pPictureResource(@Nullable VkVideoPictureResourceInfoKHR value)	Sets the address of the specified VkVideoPictureResourceInfoKHR to the pPictureResource() field.
VkVideoReferenceSlotInfoKHR	set(int sType, long pNext, int slotIndex, @Nullable VkVideoPictureResourceInfoKHR pPictureResource)	Initializes this struct with the specified values.
VkVideoReferenceSlotInfoKHR	set(VkVideoReferenceSlotInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	slotIndex()	the index of the DPB slot or a negative integer value.
VkVideoReferenceSlotInfoKHR	slotIndex(int value)	Sets the specified value to the slotIndex() field.
int	sType()	a VkStructureType value identifying this structure.
VkVideoReferenceSlotInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoReferenceSlotInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_REFERENCE_SLOT_INFO_KHR value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

SLOTINDEX

public static final int SLOTINDEX

The struct member offsets.

PPICTURERESOURCE

public static final int PPICTURERESOURCE

The struct member offsets.

Constructor Details

VkVideoReferenceSlotInfoKHR

public VkVideoReferenceSlotInfoKHR(ByteBuffer container)

Creates a VkVideoReferenceSlotInfoKHR instance at the current position of the specified ByteBuffer container. 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:

sizeof in class org.lwjgl.system.Struct<VkVideoReferenceSlotInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

slotIndex

public int slotIndex()

the index of the DPB slot or a negative integer value.

pPictureResource

public @Nullable VkVideoPictureResourceInfoKHR pPictureResource()

NULL or a pointer to a VkVideoPictureResourceInfoKHR structure describing the video picture resource associated with the DPB slot index specified by slotIndex.

sType

public VkVideoReferenceSlotInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoReferenceSlotInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_REFERENCE_SLOT_INFO_KHR value to the sType() field.

pNext

public VkVideoReferenceSlotInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkVideoReferenceSlotInfoKHR pNext(VkVideoDecodeAV1DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeAV1DpbSlotInfoKHR value to the pNext chain.

pNext

public VkVideoReferenceSlotInfoKHR pNext(VkVideoDecodeH264DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH264DpbSlotInfoKHR value to the pNext chain.

pNext

public VkVideoReferenceSlotInfoKHR pNext(VkVideoDecodeH265DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH265DpbSlotInfoKHR value to the pNext chain.

pNext

public VkVideoReferenceSlotInfoKHR pNext(VkVideoEncodeAV1DpbSlotInfoKHR value)

Prepends the specified VkVideoEncodeAV1DpbSlotInfoKHR value to the pNext chain.

pNext

public VkVideoReferenceSlotInfoKHR pNext(VkVideoEncodeH264DpbSlotInfoKHR value)

Prepends the specified VkVideoEncodeH264DpbSlotInfoKHR value to the pNext chain.

pNext

public VkVideoReferenceSlotInfoKHR pNext(VkVideoEncodeH265DpbSlotInfoKHR value)

Prepends the specified VkVideoEncodeH265DpbSlotInfoKHR value to the pNext chain.

slotIndex

public VkVideoReferenceSlotInfoKHR slotIndex(int value)

Sets the specified value to the slotIndex() field.

pPictureResource

public VkVideoReferenceSlotInfoKHR pPictureResource(@Nullable VkVideoPictureResourceInfoKHR value)

Sets the address of the specified VkVideoPictureResourceInfoKHR to the pPictureResource() field.

set

public VkVideoReferenceSlotInfoKHR set(int sType,
 long pNext,
 int slotIndex,
 @Nullable VkVideoPictureResourceInfoKHR pPictureResource)

Initializes this struct with the specified values.

set

public VkVideoReferenceSlotInfoKHR set(VkVideoReferenceSlotInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoReferenceSlotInfoKHR malloc()

Returns a new VkVideoReferenceSlotInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkVideoReferenceSlotInfoKHR calloc()

Returns a new VkVideoReferenceSlotInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkVideoReferenceSlotInfoKHR create()

Returns a new VkVideoReferenceSlotInfoKHR instance allocated with BufferUtils.

create

public static VkVideoReferenceSlotInfoKHR create(long address)

Returns a new VkVideoReferenceSlotInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoReferenceSlotInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoReferenceSlotInfoKHR.Buffer malloc(int capacity)

Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoReferenceSlotInfoKHR.Buffer calloc(int capacity)

Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkVideoReferenceSlotInfoKHR.Buffer create(int capacity)

Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkVideoReferenceSlotInfoKHR.Buffer create(long address,
 int capacity)

Create a VkVideoReferenceSlotInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkVideoReferenceSlotInfoKHR.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkVideoReferenceSlotInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkVideoReferenceSlotInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkVideoReferenceSlotInfoKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkVideoReferenceSlotInfoKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkVideoReferenceSlotInfoKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nslotIndex

public static int nslotIndex(long struct)

Unsafe version of slotIndex().

npPictureResource

public static @Nullable VkVideoPictureResourceInfoKHR npPictureResource(long struct)

Unsafe version of pPictureResource().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nslotIndex

public static void nslotIndex(long struct,
 int value)

Unsafe version of slotIndex.

npPictureResource

public static void npPictureResource(long struct,
 @Nullable VkVideoPictureResourceInfoKHR value)

Unsafe version of pPictureResource.