Package org.lwjgl.vulkan

Class VkVideoEncodeAV1FrameSizeKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeAV1FrameSizeKHR>

org.lwjgl.vulkan.VkVideoEncodeAV1FrameSizeKHR

All Implemented Interfaces:

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

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

Structure describing frame size values per AV1 prediction mode.

See Also

VkVideoEncodeAV1RateControlLayerInfoKHR

Layout

 struct VkVideoEncodeAV1FrameSizeKHR {
     uint32_t intraFrameSize();
     uint32_t predictiveFrameSize();
     uint32_t bipredictiveFrameSize();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
int	bipredictiveFrameSize()	the size in bytes to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_BIPREDICTIVE_KHR.
VkVideoEncodeAV1FrameSizeKHR	bipredictiveFrameSize(int value)	Sets the specified value to the bipredictiveFrameSize() field.
static VkVideoEncodeAV1FrameSizeKHR	calloc()	Returns a new VkVideoEncodeAV1FrameSizeKHR instance allocated with memCalloc.
static VkVideoEncodeAV1FrameSizeKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeAV1FrameSizeKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeAV1FrameSizeKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1FrameSizeKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeAV1FrameSizeKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1FrameSizeKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeAV1FrameSizeKHR	create()	Returns a new VkVideoEncodeAV1FrameSizeKHR instance allocated with BufferUtils.
static VkVideoEncodeAV1FrameSizeKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeAV1FrameSizeKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeAV1FrameSizeKHR	create(long address)	Returns a new VkVideoEncodeAV1FrameSizeKHR instance for the specified memory address.
static VkVideoEncodeAV1FrameSizeKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeAV1FrameSizeKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeAV1FrameSizeKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeAV1FrameSizeKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	intraFrameSize()	the size in bytes to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_INTRA_KHR.
VkVideoEncodeAV1FrameSizeKHR	intraFrameSize(int value)	Sets the specified value to the intraFrameSize() field.
static VkVideoEncodeAV1FrameSizeKHR	malloc()	Returns a new VkVideoEncodeAV1FrameSizeKHR instance allocated with memAlloc.
static VkVideoEncodeAV1FrameSizeKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeAV1FrameSizeKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeAV1FrameSizeKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1FrameSizeKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeAV1FrameSizeKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1FrameSizeKHR instance allocated on the specified MemoryStack.
static int	nbipredictiveFrameSize(long struct)	Unsafe version of bipredictiveFrameSize().
static void	nbipredictiveFrameSize(long struct, int value)	Unsafe version of bipredictiveFrameSize.
static int	nintraFrameSize(long struct)	Unsafe version of intraFrameSize().
static void	nintraFrameSize(long struct, int value)	Unsafe version of intraFrameSize.
static int	npredictiveFrameSize(long struct)	Unsafe version of predictiveFrameSize().
static void	npredictiveFrameSize(long struct, int value)	Unsafe version of predictiveFrameSize.
int	predictiveFrameSize()	the size in bytes to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_PREDICTIVE_KHR.
VkVideoEncodeAV1FrameSizeKHR	predictiveFrameSize(int value)	Sets the specified value to the predictiveFrameSize() field.
VkVideoEncodeAV1FrameSizeKHR	set(int intraFrameSize, int predictiveFrameSize, int bipredictiveFrameSize)	Initializes this struct with the specified values.
VkVideoEncodeAV1FrameSizeKHR	set(VkVideoEncodeAV1FrameSizeKHR 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.

INTRAFRAMESIZE

public static final int INTRAFRAMESIZE

The struct member offsets.

PREDICTIVEFRAMESIZE

public static final int PREDICTIVEFRAMESIZE

The struct member offsets.

BIPREDICTIVEFRAMESIZE

public static final int BIPREDICTIVEFRAMESIZE

The struct member offsets.

Constructor Details

VkVideoEncodeAV1FrameSizeKHR

public VkVideoEncodeAV1FrameSizeKHR(ByteBuffer container)

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

intraFrameSize

public int intraFrameSize()

the size in bytes to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_INTRA_KHR.

predictiveFrameSize

public int predictiveFrameSize()

the size in bytes to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_PREDICTIVE_KHR.

bipredictiveFrameSize

public int bipredictiveFrameSize()

the size in bytes to be used for frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_BIPREDICTIVE_KHR.

intraFrameSize

public VkVideoEncodeAV1FrameSizeKHR intraFrameSize(int value)

Sets the specified value to the intraFrameSize() field.

predictiveFrameSize

public VkVideoEncodeAV1FrameSizeKHR predictiveFrameSize(int value)

Sets the specified value to the predictiveFrameSize() field.

bipredictiveFrameSize

public VkVideoEncodeAV1FrameSizeKHR bipredictiveFrameSize(int value)

Sets the specified value to the bipredictiveFrameSize() field.

set

public VkVideoEncodeAV1FrameSizeKHR set(int intraFrameSize,
 int predictiveFrameSize,
 int bipredictiveFrameSize)

Initializes this struct with the specified values.

set

public VkVideoEncodeAV1FrameSizeKHR set(VkVideoEncodeAV1FrameSizeKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeAV1FrameSizeKHR malloc()

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

calloc

public static VkVideoEncodeAV1FrameSizeKHR calloc()

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

create

public static VkVideoEncodeAV1FrameSizeKHR create()

Returns a new VkVideoEncodeAV1FrameSizeKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeAV1FrameSizeKHR create(long address)

Returns a new VkVideoEncodeAV1FrameSizeKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeAV1FrameSizeKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeAV1FrameSizeKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeAV1FrameSizeKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeAV1FrameSizeKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeAV1FrameSizeKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeAV1FrameSizeKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeAV1FrameSizeKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nintraFrameSize

public static int nintraFrameSize(long struct)

Unsafe version of intraFrameSize().

npredictiveFrameSize

public static int npredictiveFrameSize(long struct)

Unsafe version of predictiveFrameSize().

nbipredictiveFrameSize

public static int nbipredictiveFrameSize(long struct)

Unsafe version of bipredictiveFrameSize().

nintraFrameSize

public static void nintraFrameSize(long struct,
 int value)

Unsafe version of intraFrameSize.

npredictiveFrameSize

public static void npredictiveFrameSize(long struct,
 int value)

Unsafe version of predictiveFrameSize.

nbipredictiveFrameSize

public static void nbipredictiveFrameSize(long struct,
 int value)

Unsafe version of bipredictiveFrameSize.