Package org.lwjgl.vulkan

Class VkVideoEncodeH265DpbSlotInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeH265DpbSlotInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeH265DpbSlotInfoKHR

All Implemented Interfaces:

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

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

Structure specifies H.265 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 H.265 encode operation.

Active Reference Picture Information

• The image subregion used is determined according to the H.265 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 H.265 reference information provided in pStdReferenceInfo.

Reconstructed Picture Information

• The image subregion used is determined according to the H.265 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 H.265 reference information provided in pStdReferenceInfo.

Std Reference Information

• flags.reserved is used only for padding purposes and is otherwise ignored;
• flags.used_for_long_term_reference is used to indicate whether the picture is marked as “used for long-term reference” as defined in section 8.3.2 of the ITU-T H.265 Specification;
• flags.unused_for_reference is used to indicate whether the picture is marked as “unused for reference” as defined in section 8.3.2 of the ITU-T H.265 Specification;
• pic_type as defined in section 7.4.3.5 of the ITU-T H.265 Specification;
• PicOrderCntVal as defined in section 8.3.1 of the ITU-T H.265 Specification;
• TemporalId as defined in section 7.4.2.2 of the ITU-T H.265 Specification.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_H265_DPB_SLOT_INFO_KHR
• pStdReferenceInfo must be a valid pointer to a valid StdVideoEncodeH265ReferenceInfo value

Layout

 struct VkVideoEncodeH265DpbSlotInfoKHR {
     VkStructureType sType();
     void const * pNext();
     StdVideoEncodeH265ReferenceInfo const * pStdReferenceInfo();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeH265DpbSlotInfoKHR.Buffer	An array of VkVideoEncodeH265DpbSlotInfoKHR 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
VkVideoEncodeH265DpbSlotInfoKHR(ByteBuffer container)	Creates a VkVideoEncodeH265DpbSlotInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

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

VkVideoEncodeH265DpbSlotInfoKHR

public VkVideoEncodeH265DpbSlotInfoKHR(ByteBuffer container)

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

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 StdVideoEncodeH265ReferenceInfo pStdReferenceInfo()

a pointer to a StdVideoEncodeH265ReferenceInfo structure specifying H.265 reference information.

sType

public VkVideoEncodeH265DpbSlotInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeH265DpbSlotInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H265_DPB_SLOT_INFO_KHR value to the sType() field.

pNext

public VkVideoEncodeH265DpbSlotInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pStdReferenceInfo

public VkVideoEncodeH265DpbSlotInfoKHR pStdReferenceInfo(StdVideoEncodeH265ReferenceInfo value)

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

set

public VkVideoEncodeH265DpbSlotInfoKHR set(int sType,
 long pNext,
 StdVideoEncodeH265ReferenceInfo pStdReferenceInfo)

Initializes this struct with the specified values.

set

public VkVideoEncodeH265DpbSlotInfoKHR set(VkVideoEncodeH265DpbSlotInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeH265DpbSlotInfoKHR malloc()

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

calloc

public static VkVideoEncodeH265DpbSlotInfoKHR calloc()

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

create

public static VkVideoEncodeH265DpbSlotInfoKHR create()

Returns a new VkVideoEncodeH265DpbSlotInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeH265DpbSlotInfoKHR create(long address)

Returns a new VkVideoEncodeH265DpbSlotInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeH265DpbSlotInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeH265DpbSlotInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeH265DpbSlotInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeH265DpbSlotInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeH265DpbSlotInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeH265DpbSlotInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeH265DpbSlotInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkVideoEncodeH265DpbSlotInfoKHR.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 StdVideoEncodeH265ReferenceInfo 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,
 StdVideoEncodeH265ReferenceInfo 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