Package org.lwjgl.vulkan.video

Class StdVideoEncodeAV1ReferenceInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<StdVideoEncodeAV1ReferenceInfo>

org.lwjgl.vulkan.video.StdVideoEncodeAV1ReferenceInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class StdVideoEncodeAV1ReferenceInfo
extends Struct<StdVideoEncodeAV1ReferenceInfo>
implements NativeResource

 struct StdVideoEncodeAV1ReferenceInfo {
     {@link StdVideoEncodeAV1ReferenceInfoFlags StdVideoEncodeAV1ReferenceInfoFlags} flags;
     uint32_t RefFrameId;
     StdVideoAV1FrameType frame_type;
     uint8_t OrderHint;
     uint8_t reserved1[3];
     {@link StdVideoEncodeAV1ExtensionHeader StdVideoEncodeAV1ExtensionHeader} const * pExtensionHeader;
 }

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	FRAME_TYPE	The struct member offsets.
static final int	ORDERHINT	The struct member offsets.
static final int	PEXTENSIONHEADER	The struct member offsets.
static final int	REFFRAMEID	The struct member offsets.
static final int	RESERVED1	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static StdVideoEncodeAV1ReferenceInfo	calloc()	Returns a new StdVideoEncodeAV1ReferenceInfo instance allocated with memCalloc.
static StdVideoEncodeAV1ReferenceInfo.Buffer	calloc(int capacity)	Returns a new StdVideoEncodeAV1ReferenceInfo.Buffer instance allocated with memCalloc.
static StdVideoEncodeAV1ReferenceInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new StdVideoEncodeAV1ReferenceInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static StdVideoEncodeAV1ReferenceInfo	calloc(MemoryStack stack)	Returns a new StdVideoEncodeAV1ReferenceInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static StdVideoEncodeAV1ReferenceInfo	create()	Returns a new StdVideoEncodeAV1ReferenceInfo instance allocated with BufferUtils.
static StdVideoEncodeAV1ReferenceInfo.Buffer	create(int capacity)	Returns a new StdVideoEncodeAV1ReferenceInfo.Buffer instance allocated with BufferUtils.
static StdVideoEncodeAV1ReferenceInfo	create(long address)	Returns a new StdVideoEncodeAV1ReferenceInfo instance for the specified memory address.
static StdVideoEncodeAV1ReferenceInfo.Buffer	create(long address, int capacity)	Create a StdVideoEncodeAV1ReferenceInfo.Buffer instance at the specified memory.
static @Nullable StdVideoEncodeAV1ReferenceInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable StdVideoEncodeAV1ReferenceInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
StdVideoEncodeAV1ReferenceInfoFlags	flags()
StdVideoEncodeAV1ReferenceInfo	flags(Consumer<StdVideoEncodeAV1ReferenceInfoFlags> consumer)	Passes the flags field to the specified Consumer.
StdVideoEncodeAV1ReferenceInfo	flags(StdVideoEncodeAV1ReferenceInfoFlags value)	Copies the specified StdVideoEncodeAV1ReferenceInfoFlags to the flags field.
int	frame_type()
StdVideoEncodeAV1ReferenceInfo	frame_type(int value)	Sets the specified value to the frame_type field.
static StdVideoEncodeAV1ReferenceInfo	malloc()	Returns a new StdVideoEncodeAV1ReferenceInfo instance allocated with memAlloc.
static StdVideoEncodeAV1ReferenceInfo.Buffer	malloc(int capacity)	Returns a new StdVideoEncodeAV1ReferenceInfo.Buffer instance allocated with memAlloc.
static StdVideoEncodeAV1ReferenceInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new StdVideoEncodeAV1ReferenceInfo.Buffer instance allocated on the specified MemoryStack.
static StdVideoEncodeAV1ReferenceInfo	malloc(MemoryStack stack)	Returns a new StdVideoEncodeAV1ReferenceInfo instance allocated on the specified MemoryStack.
static StdVideoEncodeAV1ReferenceInfoFlags	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, StdVideoEncodeAV1ReferenceInfoFlags value)	Unsafe version of flags.
static int	nframe_type(long struct)	Unsafe version of frame_type().
static void	nframe_type(long struct, int value)	Unsafe version of frame_type.
static byte	nOrderHint(long struct)	Unsafe version of OrderHint().
static void	nOrderHint(long struct, byte value)	Unsafe version of OrderHint.
static StdVideoEncodeAV1ExtensionHeader	npExtensionHeader(long struct)	Unsafe version of pExtensionHeader().
static void	npExtensionHeader(long struct, StdVideoEncodeAV1ExtensionHeader value)	Unsafe version of pExtensionHeader.
static int	nRefFrameId(long struct)	Unsafe version of RefFrameId().
static void	nRefFrameId(long struct, int value)	Unsafe version of RefFrameId.
static ByteBuffer	nreserved1(long struct)
static byte	nreserved1(long struct, int index)
static void	nreserved1(long struct, int index, byte value)
static void	nreserved1(long struct, ByteBuffer value)
byte	OrderHint()
StdVideoEncodeAV1ReferenceInfo	OrderHint(byte value)	Sets the specified value to the OrderHint field.
StdVideoEncodeAV1ExtensionHeader	pExtensionHeader()
StdVideoEncodeAV1ReferenceInfo	pExtensionHeader(StdVideoEncodeAV1ExtensionHeader value)	Sets the address of the specified StdVideoEncodeAV1ExtensionHeader to the pExtensionHeader field.
int	RefFrameId()
StdVideoEncodeAV1ReferenceInfo	RefFrameId(int value)	Sets the specified value to the RefFrameId field.
StdVideoEncodeAV1ReferenceInfo	set(StdVideoEncodeAV1ReferenceInfo src)	Copies the specified struct data to this struct.
StdVideoEncodeAV1ReferenceInfo	set(StdVideoEncodeAV1ReferenceInfoFlags flags, int RefFrameId, int frame_type, byte OrderHint, StdVideoEncodeAV1ExtensionHeader pExtensionHeader)	Initializes this struct with the specified values.
int	sizeof()	Returns sizeof(struct).
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.

FLAGS

public static final int FLAGS

The struct member offsets.

REFFRAMEID

public static final int REFFRAMEID

The struct member offsets.

FRAME_TYPE

public static final int FRAME_TYPE

The struct member offsets.

ORDERHINT

public static final int ORDERHINT

The struct member offsets.

RESERVED1

public static final int RESERVED1

The struct member offsets.

PEXTENSIONHEADER

public static final int PEXTENSIONHEADER

The struct member offsets.

Constructor Details

StdVideoEncodeAV1ReferenceInfo

public StdVideoEncodeAV1ReferenceInfo(ByteBuffer container)

Creates a StdVideoEncodeAV1ReferenceInfo 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<StdVideoEncodeAV1ReferenceInfo>

flags

public StdVideoEncodeAV1ReferenceInfoFlags flags()

Returns:

a StdVideoEncodeAV1ReferenceInfoFlags view of the flags field.

RefFrameId

public int RefFrameId()

Returns:

the value of the RefFrameId field.

frame_type

public int frame_type()

Returns:

the value of the frame_type field.

OrderHint

public byte OrderHint()

Returns:

the value of the OrderHint field.

pExtensionHeader

public StdVideoEncodeAV1ExtensionHeader pExtensionHeader()

Returns:

a StdVideoEncodeAV1ExtensionHeader view of the struct pointed to by the pExtensionHeader field.

flags

public StdVideoEncodeAV1ReferenceInfo flags(StdVideoEncodeAV1ReferenceInfoFlags value)

Copies the specified StdVideoEncodeAV1ReferenceInfoFlags to the flags field.

flags

public StdVideoEncodeAV1ReferenceInfo flags(Consumer<StdVideoEncodeAV1ReferenceInfoFlags> consumer)

Passes the flags field to the specified Consumer.

RefFrameId

public StdVideoEncodeAV1ReferenceInfo RefFrameId(int value)

Sets the specified value to the RefFrameId field.

frame_type

public StdVideoEncodeAV1ReferenceInfo frame_type(int value)

Sets the specified value to the frame_type field.

OrderHint

public StdVideoEncodeAV1ReferenceInfo OrderHint(byte value)

Sets the specified value to the OrderHint field.

pExtensionHeader

public StdVideoEncodeAV1ReferenceInfo pExtensionHeader(StdVideoEncodeAV1ExtensionHeader value)

Sets the address of the specified StdVideoEncodeAV1ExtensionHeader to the pExtensionHeader field.

set

public StdVideoEncodeAV1ReferenceInfo set(StdVideoEncodeAV1ReferenceInfoFlags flags,
 int RefFrameId,
 int frame_type,
 byte OrderHint,
 StdVideoEncodeAV1ExtensionHeader pExtensionHeader)

Initializes this struct with the specified values.

set

public StdVideoEncodeAV1ReferenceInfo set(StdVideoEncodeAV1ReferenceInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static StdVideoEncodeAV1ReferenceInfo malloc()

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

calloc

public static StdVideoEncodeAV1ReferenceInfo calloc()

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

create

public static StdVideoEncodeAV1ReferenceInfo create()

Returns a new StdVideoEncodeAV1ReferenceInfo instance allocated with BufferUtils.

create

public static StdVideoEncodeAV1ReferenceInfo create(long address)

Returns a new StdVideoEncodeAV1ReferenceInfo instance for the specified memory address.

createSafe

public static @Nullable StdVideoEncodeAV1ReferenceInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static StdVideoEncodeAV1ReferenceInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static StdVideoEncodeAV1ReferenceInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static StdVideoEncodeAV1ReferenceInfo.Buffer create(int capacity)

Returns a new StdVideoEncodeAV1ReferenceInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a StdVideoEncodeAV1ReferenceInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static StdVideoEncodeAV1ReferenceInfo malloc(MemoryStack stack)

Returns a new StdVideoEncodeAV1ReferenceInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static StdVideoEncodeAV1ReferenceInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static StdVideoEncodeAV1ReferenceInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static StdVideoEncodeAV1ReferenceInfo.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new StdVideoEncodeAV1ReferenceInfo.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

nflags

public static StdVideoEncodeAV1ReferenceInfoFlags nflags(long struct)

Unsafe version of flags().

nRefFrameId

public static int nRefFrameId(long struct)

Unsafe version of RefFrameId().

nframe_type

public static int nframe_type(long struct)

Unsafe version of frame_type().

nOrderHint

public static byte nOrderHint(long struct)

Unsafe version of OrderHint().

nreserved1

public static ByteBuffer nreserved1(long struct)

nreserved1

public static byte nreserved1(long struct,
 int index)

npExtensionHeader

public static StdVideoEncodeAV1ExtensionHeader npExtensionHeader(long struct)

Unsafe version of pExtensionHeader().

nflags

public static void nflags(long struct,
 StdVideoEncodeAV1ReferenceInfoFlags value)

Unsafe version of flags.

nRefFrameId

public static void nRefFrameId(long struct,
 int value)

Unsafe version of RefFrameId.

nframe_type

public static void nframe_type(long struct,
 int value)

Unsafe version of frame_type.

nOrderHint

public static void nOrderHint(long struct,
 byte value)

Unsafe version of OrderHint.

nreserved1

public static void nreserved1(long struct,
 ByteBuffer value)

nreserved1

public static void nreserved1(long struct,
 int index,
 byte value)

npExtensionHeader

public static void npExtensionHeader(long struct,
 StdVideoEncodeAV1ExtensionHeader value)

Unsafe version of pExtensionHeader.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate