Package org.lwjgl.vulkan

Class VkVideoEncodeAV1QIndexKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeAV1QIndexKHR>

org.lwjgl.vulkan.VkVideoEncodeAV1QIndexKHR

All Implemented Interfaces:

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

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

Structure describing AV1 quantizer index values per prediction mode.

See Also

VkVideoEncodeAV1QualityLevelPropertiesKHR, VkVideoEncodeAV1RateControlLayerInfoKHR

Layout

 struct VkVideoEncodeAV1QIndexKHR {
     uint32_t intraQIndex();
     uint32_t predictiveQIndex();
     uint32_t bipredictiveQIndex();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeAV1QIndexKHR.Buffer	An array of VkVideoEncodeAV1QIndexKHR 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	BIPREDICTIVEQINDEX	The struct member offsets.
static final int	INTRAQINDEX	The struct member offsets.
static final int	PREDICTIVEQINDEX	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
VkVideoEncodeAV1QIndexKHR(ByteBuffer container)	Creates a VkVideoEncodeAV1QIndexKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	bipredictiveQIndex()	the quantizer index to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_BIPREDICTIVE_KHR.
VkVideoEncodeAV1QIndexKHR	bipredictiveQIndex(int value)	Sets the specified value to the bipredictiveQIndex() field.
static VkVideoEncodeAV1QIndexKHR	calloc()	Returns a new VkVideoEncodeAV1QIndexKHR instance allocated with memCalloc.
static VkVideoEncodeAV1QIndexKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeAV1QIndexKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeAV1QIndexKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1QIndexKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeAV1QIndexKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1QIndexKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeAV1QIndexKHR	create()	Returns a new VkVideoEncodeAV1QIndexKHR instance allocated with BufferUtils.
static VkVideoEncodeAV1QIndexKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeAV1QIndexKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeAV1QIndexKHR	create(long address)	Returns a new VkVideoEncodeAV1QIndexKHR instance for the specified memory address.
static VkVideoEncodeAV1QIndexKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeAV1QIndexKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeAV1QIndexKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeAV1QIndexKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	intraQIndex()	the quantizer index to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_INTRA_KHR.
VkVideoEncodeAV1QIndexKHR	intraQIndex(int value)	Sets the specified value to the intraQIndex() field.
static VkVideoEncodeAV1QIndexKHR	malloc()	Returns a new VkVideoEncodeAV1QIndexKHR instance allocated with memAlloc.
static VkVideoEncodeAV1QIndexKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeAV1QIndexKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeAV1QIndexKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1QIndexKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeAV1QIndexKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1QIndexKHR instance allocated on the specified MemoryStack.
static int	nbipredictiveQIndex(long struct)	Unsafe version of bipredictiveQIndex().
static void	nbipredictiveQIndex(long struct, int value)	Unsafe version of bipredictiveQIndex.
static int	nintraQIndex(long struct)	Unsafe version of intraQIndex().
static void	nintraQIndex(long struct, int value)	Unsafe version of intraQIndex.
static int	npredictiveQIndex(long struct)	Unsafe version of predictiveQIndex().
static void	npredictiveQIndex(long struct, int value)	Unsafe version of predictiveQIndex.
int	predictiveQIndex()	the quantizer index to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_PREDICTIVE_KHR.
VkVideoEncodeAV1QIndexKHR	predictiveQIndex(int value)	Sets the specified value to the predictiveQIndex() field.
VkVideoEncodeAV1QIndexKHR	set(int intraQIndex, int predictiveQIndex, int bipredictiveQIndex)	Initializes this struct with the specified values.
VkVideoEncodeAV1QIndexKHR	set(VkVideoEncodeAV1QIndexKHR src)	Copies the specified struct data to this struct.
int	sizeof()

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.

INTRAQINDEX

public static final int INTRAQINDEX

The struct member offsets.

PREDICTIVEQINDEX

public static final int PREDICTIVEQINDEX

The struct member offsets.

BIPREDICTIVEQINDEX

public static final int BIPREDICTIVEQINDEX

The struct member offsets.

Constructor Details

VkVideoEncodeAV1QIndexKHR

public VkVideoEncodeAV1QIndexKHR(ByteBuffer container)

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

intraQIndex

public int intraQIndex()

the quantizer index to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_INTRA_KHR.

predictiveQIndex

public int predictiveQIndex()

the quantizer index to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_PREDICTIVE_KHR.

bipredictiveQIndex

public int bipredictiveQIndex()

the quantizer index to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_BIPREDICTIVE_KHR.

intraQIndex

public VkVideoEncodeAV1QIndexKHR intraQIndex(int value)

Sets the specified value to the intraQIndex() field.

predictiveQIndex

public VkVideoEncodeAV1QIndexKHR predictiveQIndex(int value)

Sets the specified value to the predictiveQIndex() field.

bipredictiveQIndex

public VkVideoEncodeAV1QIndexKHR bipredictiveQIndex(int value)

Sets the specified value to the bipredictiveQIndex() field.

set

public VkVideoEncodeAV1QIndexKHR set(int intraQIndex,
 int predictiveQIndex,
 int bipredictiveQIndex)

Initializes this struct with the specified values.

set

public VkVideoEncodeAV1QIndexKHR set(VkVideoEncodeAV1QIndexKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeAV1QIndexKHR malloc()

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

calloc

public static VkVideoEncodeAV1QIndexKHR calloc()

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

create

public static VkVideoEncodeAV1QIndexKHR create()

Returns a new VkVideoEncodeAV1QIndexKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeAV1QIndexKHR create(long address)

Returns a new VkVideoEncodeAV1QIndexKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeAV1QIndexKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeAV1QIndexKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeAV1QIndexKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeAV1QIndexKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeAV1QIndexKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeAV1QIndexKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeAV1QIndexKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nintraQIndex

public static int nintraQIndex(long struct)

Unsafe version of intraQIndex().

npredictiveQIndex

public static int npredictiveQIndex(long struct)

Unsafe version of predictiveQIndex().

nbipredictiveQIndex

public static int nbipredictiveQIndex(long struct)

Unsafe version of bipredictiveQIndex().

nintraQIndex

public static void nintraQIndex(long struct,
 int value)

Unsafe version of intraQIndex.

npredictiveQIndex

public static void npredictiveQIndex(long struct,
 int value)

Unsafe version of predictiveQIndex.

nbipredictiveQIndex

public static void nbipredictiveQIndex(long struct,
 int value)

Unsafe version of bipredictiveQIndex.