Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoReferenceSlotInfoKHR

extends Struct<VkVideoReferenceSlotInfoKHR>
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 information about a reference picture slot.
Valid Usage (Implicit)
See Also

VkVideoBeginCodingInfoKHR, VkVideoDecodeInfoKHR, VkVideoEncodeInfoKHR, VkVideoPictureResourceInfoKHR

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
PPICTURERESOURCE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SLOTINDEX

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
VkVideoReferenceSlotInfoKHR(long address, ByteBuffer container)

public
VkVideoReferenceSlotInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoReferenceSlotInfoKHR
calloc()

Returns a new VkVideoReferenceSlotInfoKHR instance allocated with memCalloc.

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

Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkVideoReferenceSlotInfoKHR
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 VkVideoReferenceSlotInfoKHR
create()

Returns a new VkVideoReferenceSlotInfoKHR instance allocated with BufferUtils.

public static VkVideoReferenceSlotInfoKHR
create(long address)

Returns a new VkVideoReferenceSlotInfoKHR instance for the specified memory address.

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

Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkVideoReferenceSlotInfoKHR.Buffer instance at the specified memory.

public static VkVideoReferenceSlotInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkVideoReferenceSlotInfoKHR
malloc()

Returns a new VkVideoReferenceSlotInfoKHR instance allocated with memAlloc.

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

Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoReferenceSlotInfoKHR instance allocated on the specified MemoryStack.

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

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

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkVideoPictureResourceInfoKHR
npPictureResource(long struct)

Unsafe version of pPictureResource.

public static void
public static int
nslotIndex(long struct)

Unsafe version of slotIndex.

public static void
nslotIndex(long struct, int value)

Unsafe version of slotIndex.

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 VkVideoReferenceSlotInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkVideoReferenceSlotInfoKHR
pNext(VkVideoDecodeH264DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH264DpbSlotInfoKHR value to the pNext chain.

public VkVideoReferenceSlotInfoKHR
pNext(VkVideoDecodeH265DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH265DpbSlotInfoKHR value to the pNext chain.

public VkVideoReferenceSlotInfoKHR
pNext(VkVideoEncodeH264DpbSlotInfoEXT value)

Prepends the specified VkVideoEncodeH264DpbSlotInfoEXT value to the pNext chain.

public VkVideoReferenceSlotInfoKHR
pNext(VkVideoEncodeH265DpbSlotInfoEXT value)

Prepends the specified VkVideoEncodeH265DpbSlotInfoEXT value to the pNext chain.

public VkVideoPictureResourceInfoKHR
pPictureResource()

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

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

Initializes this struct with the specified values.

public VkVideoReferenceSlotInfoKHR

Returns:

this struct
set
(VkVideoReferenceSlotInfoKHR
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 int
slotIndex()

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

public VkVideoReferenceSlotInfoKHR
slotIndex(int value)

Sets the specified value to the slotIndex field.

public int
sType()

a VkStructureType value identifying this structure.

public VkVideoReferenceSlotInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkVideoReferenceSlotInfoKHR
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PPICTURERESOURCEback to summary
public static final int PPICTURERESOURCE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SLOTINDEXback to summary
public static final int SLOTINDEX

The struct member offsets.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkVideoReferenceSlotInfoKHRback to summary
protected VkVideoReferenceSlotInfoKHR(long address, ByteBuffer container)
VkVideoReferenceSlotInfoKHRback to summary
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 Detail

callocback to summary
public static VkVideoReferenceSlotInfoKHR calloc()

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

callocback to summary
public static VkVideoReferenceSlotInfoKHR.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoReferenceSlotInfoKHR calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkVideoReferenceSlotInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkVideoReferenceSlotInfoKHR create(long address, ByteBuffer container)

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

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkVideoReferenceSlotInfoKHR create()

Returns a new VkVideoReferenceSlotInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoReferenceSlotInfoKHR create(long address)

Returns a new VkVideoReferenceSlotInfoKHR instance for the specified memory address.

createback to summary
public static VkVideoReferenceSlotInfoKHR.Buffer create(int capacity)

Returns a new VkVideoReferenceSlotInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoReferenceSlotInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoReferenceSlotInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkVideoReferenceSlotInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkVideoReferenceSlotInfoKHR malloc()

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

mallocback to summary
public static VkVideoReferenceSlotInfoKHR.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoReferenceSlotInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoReferenceSlotInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkVideoReferenceSlotInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

npPictureResourceback to summary
public static VkVideoPictureResourceInfoKHR npPictureResource(long struct)

Unsafe version of pPictureResource.

Annotations
@Nullable
npPictureResourceback to summary
public static void npPictureResource(long struct, VkVideoPictureResourceInfoKHR value)

Unsafe version of pPictureResource.

nslotIndexback to summary
public static int nslotIndex(long struct)

Unsafe version of slotIndex.

nslotIndexback to summary
public static void nslotIndex(long struct, int value)

Unsafe version of slotIndex.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkVideoReferenceSlotInfoKHR pNext(long value)

Sets the specified value to the pNext field.

pNextback to summary
public VkVideoReferenceSlotInfoKHR pNext(VkVideoDecodeH264DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH264DpbSlotInfoKHR value to the pNext chain.

pNextback to summary
public VkVideoReferenceSlotInfoKHR pNext(VkVideoDecodeH265DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH265DpbSlotInfoKHR value to the pNext chain.

pNextback to summary
public VkVideoReferenceSlotInfoKHR pNext(VkVideoEncodeH264DpbSlotInfoEXT value)

Prepends the specified VkVideoEncodeH264DpbSlotInfoEXT value to the pNext chain.

pNextback to summary
public VkVideoReferenceSlotInfoKHR pNext(VkVideoEncodeH265DpbSlotInfoEXT value)

Prepends the specified VkVideoEncodeH265DpbSlotInfoEXT value to the pNext chain.

pPictureResourceback to summary
public VkVideoPictureResourceInfoKHR pPictureResource()

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

Annotations
@Nullable
@NativeType:VkVideoPictureResourceInfoKHR const *
pPictureResourceback to summary
public VkVideoReferenceSlotInfoKHR pPictureResource(VkVideoPictureResourceInfoKHR value)

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

setback to summary
public VkVideoReferenceSlotInfoKHR set(int sType, long pNext, int slotIndex, VkVideoPictureResourceInfoKHR pPictureResource)

Initializes this struct with the specified values.

setback to summary
public VkVideoReferenceSlotInfoKHR set(VkVideoReferenceSlotInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoReferenceSlotInfoKHR

the source struct

Returns:VkVideoReferenceSlotInfoKHR

this struct

sizeofback to summary
public int sizeof()

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

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
slotIndexback to summary
public int slotIndex()

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

Annotations
@NativeType:int32_t
slotIndexback to summary
public VkVideoReferenceSlotInfoKHR slotIndex(int value)

Sets the specified value to the slotIndex field.

sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkVideoReferenceSlotInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkVideoReferenceSlotInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_REFERENCE_SLOT_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkVideoReferenceSlotInfoKHR.Buffer

extends StructBuffer<VkVideoReferenceSlotInfoKHR, VkVideoReferenceSlotInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkVideoReferenceSlotInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoReferenceSlotInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVideoReferenceSlotInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkVideoReferenceSlotInfoKHR
public long

Returns:

the value of the VkVideoReferenceSlotInfoKHR#pNext field.
pNext
()

public VkVideoReferenceSlotInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoReferenceSlotInfoKHR#pNext field.

public VkVideoReferenceSlotInfoKHR.Buffer
pNext(VkVideoDecodeH264DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH264DpbSlotInfoKHR value to the pNext chain.

public VkVideoReferenceSlotInfoKHR.Buffer
pNext(VkVideoDecodeH265DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH265DpbSlotInfoKHR value to the pNext chain.

public VkVideoReferenceSlotInfoKHR.Buffer
pNext(VkVideoEncodeH264DpbSlotInfoEXT value)

Prepends the specified VkVideoEncodeH264DpbSlotInfoEXT value to the pNext chain.

public VkVideoReferenceSlotInfoKHR.Buffer
pNext(VkVideoEncodeH265DpbSlotInfoEXT value)

Prepends the specified VkVideoEncodeH265DpbSlotInfoEXT value to the pNext chain.

public VkVideoPictureResourceInfoKHR
public VkVideoReferenceSlotInfoKHR.Buffer
protected VkVideoReferenceSlotInfoKHR.Buffer
public int

Returns:

the value of the VkVideoReferenceSlotInfoKHR#slotIndex field.
slotIndex
()

public VkVideoReferenceSlotInfoKHR.Buffer
slotIndex(int value)

Sets the specified value to the VkVideoReferenceSlotInfoKHR#slotIndex field.

public int

Returns:

the value of the VkVideoReferenceSlotInfoKHR#sType field.
sType
()

public VkVideoReferenceSlotInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoReferenceSlotInfoKHR#sType field.

public VkVideoReferenceSlotInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoReferenceSlotInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkVideoReferenceSlotInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkVideoReferenceSlotInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkVideoReferenceSlotInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkVideoReferenceSlotInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkVideoReferenceSlotInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkVideoReferenceSlotInfoKHR#pNext field.

pNextback to summary
public VkVideoReferenceSlotInfoKHR.Buffer pNext(VkVideoDecodeH264DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH264DpbSlotInfoKHR value to the pNext chain.

pNextback to summary
public VkVideoReferenceSlotInfoKHR.Buffer pNext(VkVideoDecodeH265DpbSlotInfoKHR value)

Prepends the specified VkVideoDecodeH265DpbSlotInfoKHR value to the pNext chain.

pNextback to summary
public VkVideoReferenceSlotInfoKHR.Buffer pNext(VkVideoEncodeH264DpbSlotInfoEXT value)

Prepends the specified VkVideoEncodeH264DpbSlotInfoEXT value to the pNext chain.

pNextback to summary
public VkVideoReferenceSlotInfoKHR.Buffer pNext(VkVideoEncodeH265DpbSlotInfoEXT value)

Prepends the specified VkVideoEncodeH265DpbSlotInfoEXT value to the pNext chain.

pPictureResourceback to summary
public VkVideoPictureResourceInfoKHR pPictureResource()
Returns:VkVideoPictureResourceInfoKHR

a VkVideoPictureResourceInfoKHR view of the struct pointed to by the VkVideoReferenceSlotInfoKHR#pPictureResource field.

Annotations
@Nullable
@NativeType:VkVideoPictureResourceInfoKHR const *
pPictureResourceback to summary
public VkVideoReferenceSlotInfoKHR.Buffer pPictureResource(VkVideoPictureResourceInfoKHR value)

Sets the address of the specified VkVideoPictureResourceInfoKHR to the VkVideoReferenceSlotInfoKHR#pPictureResource field.

selfback to summary
protected VkVideoReferenceSlotInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
slotIndexback to summary
public int slotIndex()
Returns:int

the value of the VkVideoReferenceSlotInfoKHR#slotIndex field.

Annotations
@NativeType:int32_t
slotIndexback to summary
public VkVideoReferenceSlotInfoKHR.Buffer slotIndex(int value)

Sets the specified value to the VkVideoReferenceSlotInfoKHR#slotIndex field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkVideoReferenceSlotInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkVideoReferenceSlotInfoKHR.Buffer sType(int value)

Sets the specified value to the VkVideoReferenceSlotInfoKHR#sType field.

sType$Defaultback to summary
public VkVideoReferenceSlotInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_REFERENCE_SLOT_INFO_KHR value to the VkVideoReferenceSlotInfoKHR#sType field.