Package org.lwjgl.vulkan

Class VkVideoEncodeAV1DpbSlotInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeAV1DpbSlotInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeAV1DpbSlotInfoKHR

All Implemented Interfaces:

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

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

Structure specifies AV1 encode DPB picture information.

Description

This structure is specified in the pNext chain of VkVideoEncodeInfoKHR::pSetupReferenceSlot, if not NULL, and the pNext chain of the elements of VkVideoEncodeInfoKHR::pReferenceSlots to specify the codec-specific reference picture information for an AV1 encode operation.

Active Reference Picture Information

• The image subregion used is determined according to the AV1 Encode Picture Data Access section.
• The reference picture is associated with the DPB slot index specified in the slotIndex member of the corresponding element of VkVideoEncodeInfoKHR::pReferenceSlots.
• The reference picture is associated with the AV1 reference information provided in pStdReferenceInfo.

Reconstructed Picture Information

• The image subregion used is determined according to the AV1 Encode Picture Data Access section.
• If reference picture setup is requested, then the reconstructed picture is used to activate the DPB slot with the index specified in VkVideoEncodeInfoKHR::pSetupReferenceSlot→slotIndex.
• The reconstructed picture is associated with the AV1 reference information provided in pStdReferenceInfo.

Std Reference Information

• flags.reserved and reserved1 are used only for padding purposes and are otherwise ignored;
• flags.disable_frame_end_update_cdf is interpreted as defined in section 6.8.2 of the AV1 Specification;
• flags.segmentation_enabled is interpreted as defined in section 6.8.13 of the AV1 Specification;
• RefFrameId is interpreted as the element of the RefFrameId array defined in section 6.8.2 of the AV1 Specification corresponding to the reference frame;
• frame_type is interpreted as defined in section 6.8.2 of the AV1 Specification;
• OrderHint is interpreted as defined in section 6.8.2 of the AV1 Specification;
• pExtensionHeader is NULL or a pointer to a StdVideoEncodeAV1ExtensionHeader structure whose temporal_id and spatial_id members specify the temporal and spatial layer ID of the reference frame, respectively.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_AV1_DPB_SLOT_INFO_KHR
• pStdReferenceInfo must be a valid pointer to a valid StdVideoEncodeAV1ReferenceInfo value

Layout

 struct VkVideoEncodeAV1DpbSlotInfoKHR {
     VkStructureType sType();
     void const * pNext();
     StdVideoEncodeAV1ReferenceInfo const * pStdReferenceInfo();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeAV1DpbSlotInfoKHR.Buffer	An array of VkVideoEncodeAV1DpbSlotInfoKHR 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	PSTDREFERENCEINFO	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
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
VkVideoEncodeAV1DpbSlotInfoKHR(ByteBuffer container)	Creates a VkVideoEncodeAV1DpbSlotInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeAV1DpbSlotInfoKHR	calloc()	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR instance allocated with memCalloc.
static VkVideoEncodeAV1DpbSlotInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeAV1DpbSlotInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeAV1DpbSlotInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeAV1DpbSlotInfoKHR	create()	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeAV1DpbSlotInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeAV1DpbSlotInfoKHR	create(long address)	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR instance for the specified memory address.
static VkVideoEncodeAV1DpbSlotInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeAV1DpbSlotInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeAV1DpbSlotInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeAV1DpbSlotInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoEncodeAV1DpbSlotInfoKHR	malloc()	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR instance allocated with memAlloc.
static VkVideoEncodeAV1DpbSlotInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeAV1DpbSlotInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeAV1DpbSlotInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1DpbSlotInfoKHR 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 StdVideoEncodeAV1ReferenceInfo	npStdReferenceInfo(long struct)	Unsafe version of pStdReferenceInfo().
static void	npStdReferenceInfo(long struct, StdVideoEncodeAV1ReferenceInfo value)	Unsafe version of pStdReferenceInfo.
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.
VkVideoEncodeAV1DpbSlotInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
StdVideoEncodeAV1ReferenceInfo	pStdReferenceInfo()	a pointer to a StdVideoEncodeAV1ReferenceInfo structure specifying AV1 reference information.
VkVideoEncodeAV1DpbSlotInfoKHR	pStdReferenceInfo(StdVideoEncodeAV1ReferenceInfo value)	Sets the address of the specified StdVideoEncodeAV1ReferenceInfo to the pStdReferenceInfo() field.
VkVideoEncodeAV1DpbSlotInfoKHR	set(int sType, long pNext, StdVideoEncodeAV1ReferenceInfo pStdReferenceInfo)	Initializes this struct with the specified values.
VkVideoEncodeAV1DpbSlotInfoKHR	set(VkVideoEncodeAV1DpbSlotInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeAV1DpbSlotInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeAV1DpbSlotInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_AV1_DPB_SLOT_INFO_KHR value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

PSTDREFERENCEINFO

public static final int PSTDREFERENCEINFO

The struct member offsets.

Constructor Details

VkVideoEncodeAV1DpbSlotInfoKHR

public VkVideoEncodeAV1DpbSlotInfoKHR(ByteBuffer container)

Creates a VkVideoEncodeAV1DpbSlotInfoKHR 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<VkVideoEncodeAV1DpbSlotInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pStdReferenceInfo

public StdVideoEncodeAV1ReferenceInfo pStdReferenceInfo()

a pointer to a StdVideoEncodeAV1ReferenceInfo structure specifying AV1 reference information.

sType

public VkVideoEncodeAV1DpbSlotInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeAV1DpbSlotInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_AV1_DPB_SLOT_INFO_KHR value to the sType() field.

pNext

public VkVideoEncodeAV1DpbSlotInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pStdReferenceInfo

public VkVideoEncodeAV1DpbSlotInfoKHR pStdReferenceInfo(StdVideoEncodeAV1ReferenceInfo value)

Sets the address of the specified StdVideoEncodeAV1ReferenceInfo to the pStdReferenceInfo() field.

set

public VkVideoEncodeAV1DpbSlotInfoKHR set(int sType,
 long pNext,
 StdVideoEncodeAV1ReferenceInfo pStdReferenceInfo)

Initializes this struct with the specified values.

set

public VkVideoEncodeAV1DpbSlotInfoKHR set(VkVideoEncodeAV1DpbSlotInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeAV1DpbSlotInfoKHR malloc()

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

calloc

public static VkVideoEncodeAV1DpbSlotInfoKHR calloc()

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

create

public static VkVideoEncodeAV1DpbSlotInfoKHR create()

Returns a new VkVideoEncodeAV1DpbSlotInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeAV1DpbSlotInfoKHR create(long address)

Returns a new VkVideoEncodeAV1DpbSlotInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeAV1DpbSlotInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeAV1DpbSlotInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeAV1DpbSlotInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeAV1DpbSlotInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeAV1DpbSlotInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeAV1DpbSlotInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeAV1DpbSlotInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkVideoEncodeAV1DpbSlotInfoKHR.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().

npStdReferenceInfo

public static StdVideoEncodeAV1ReferenceInfo npStdReferenceInfo(long struct)

Unsafe version of pStdReferenceInfo().

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.

npStdReferenceInfo

public static void npStdReferenceInfo(long struct,
 StdVideoEncodeAV1ReferenceInfo value)

Unsafe version of pStdReferenceInfo.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate