Package org.lwjgl.vulkan

Class VkVideoEncodeAV1RateControlInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeAV1RateControlInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeAV1RateControlInfoKHR

All Implemented Interfaces:

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

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

Structure describing AV1 stream rate control parameters.

Description

When an instance of this structure is included in the pNext chain of the VkVideoCodingControlInfoKHR structure passed to the CmdControlVideoCodingKHR command, and VkVideoCodingControlInfoKHR::flags includes VIDEO_CODING_CONTROL_ENCODE_RATE_CONTROL_BIT_KHR, the parameters in this structure are used as guidance for the implementation’s rate control algorithm (see Video Coding Control).

Valid Usage

• If flags contains VIDEO_ENCODE_AV1_RATE_CONTROL_REFERENCE_PATTERN_FLAT_BIT_KHR or VIDEO_ENCODE_AV1_RATE_CONTROL_REFERENCE_PATTERN_DYADIC_BIT_KHR, then it must also contain VIDEO_ENCODE_AV1_RATE_CONTROL_REGULAR_GOP_BIT_KHR
• If flags contains VIDEO_ENCODE_AV1_RATE_CONTROL_REFERENCE_PATTERN_FLAT_BIT_KHR, then it must not also contain VIDEO_ENCODE_AV1_RATE_CONTROL_REFERENCE_PATTERN_DYADIC_BIT_KHR
• If flags contains VIDEO_ENCODE_AV1_RATE_CONTROL_REGULAR_GOP_BIT_KHR, then gopFrameCount must be greater than 0
• If keyFramePeriod is not 0, then it must be greater than or equal to gopFrameCount
• If consecutiveBipredictiveFrameCount is not 0, then it must be less than gopFrameCount
• temporalLayerCount must be less than or equal to VkVideoEncodeAV1CapabilitiesKHR::maxTemporalLayerCount, as returned by GetPhysicalDeviceVideoCapabilitiesKHR for the used video profile

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_AV1_RATE_CONTROL_INFO_KHR
• flags must be a valid combination of VkVideoEncodeAV1RateControlFlagBitsKHR values

Layout

 struct VkVideoEncodeAV1RateControlInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkVideoEncodeAV1RateControlFlagsKHR flags();
     uint32_t gopFrameCount();
     uint32_t keyFramePeriod();
     uint32_t consecutiveBipredictiveFrameCount();
     uint32_t temporalLayerCount();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeAV1RateControlInfoKHR	calloc()	Returns a new VkVideoEncodeAV1RateControlInfoKHR instance allocated with memCalloc.
static VkVideoEncodeAV1RateControlInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeAV1RateControlInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeAV1RateControlInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1RateControlInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeAV1RateControlInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1RateControlInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	consecutiveBipredictiveFrameCount()	the number of consecutive frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_BIPREDICTIVE_KHR between frames encoded with other rate control groups within the GOP.
VkVideoEncodeAV1RateControlInfoKHR	consecutiveBipredictiveFrameCount(int value)	Sets the specified value to the consecutiveBipredictiveFrameCount() field.
static VkVideoEncodeAV1RateControlInfoKHR	create()	Returns a new VkVideoEncodeAV1RateControlInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeAV1RateControlInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeAV1RateControlInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeAV1RateControlInfoKHR	create(long address)	Returns a new VkVideoEncodeAV1RateControlInfoKHR instance for the specified memory address.
static VkVideoEncodeAV1RateControlInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeAV1RateControlInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeAV1RateControlInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeAV1RateControlInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask of VkVideoEncodeAV1RateControlFlagBitsKHR specifying AV1 rate control flags.
VkVideoEncodeAV1RateControlInfoKHR	flags(int value)	Sets the specified value to the flags() field.
int	gopFrameCount()	the number of frames within a group of pictures (GOP) intended to be used by the application.
VkVideoEncodeAV1RateControlInfoKHR	gopFrameCount(int value)	Sets the specified value to the gopFrameCount() field.
int	keyFramePeriod()	the interval, in terms of number of frames, between two frames with the AV1 frame type STD_VIDEO_AV1_FRAME_TYPE_KEY (see key frame period).
VkVideoEncodeAV1RateControlInfoKHR	keyFramePeriod(int value)	Sets the specified value to the keyFramePeriod() field.
static VkVideoEncodeAV1RateControlInfoKHR	malloc()	Returns a new VkVideoEncodeAV1RateControlInfoKHR instance allocated with memAlloc.
static VkVideoEncodeAV1RateControlInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeAV1RateControlInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeAV1RateControlInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1RateControlInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeAV1RateControlInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1RateControlInfoKHR instance allocated on the specified MemoryStack.
static int	nconsecutiveBipredictiveFrameCount(long struct)	Unsafe version of consecutiveBipredictiveFrameCount().
static void	nconsecutiveBipredictiveFrameCount(long struct, int value)	Unsafe version of consecutiveBipredictiveFrameCount.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static int	ngopFrameCount(long struct)	Unsafe version of gopFrameCount().
static void	ngopFrameCount(long struct, int value)	Unsafe version of gopFrameCount.
static int	nkeyFramePeriod(long struct)	Unsafe version of keyFramePeriod().
static void	nkeyFramePeriod(long struct, int value)	Unsafe version of keyFramePeriod.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	ntemporalLayerCount(long struct)	Unsafe version of temporalLayerCount().
static void	ntemporalLayerCount(long struct, int value)	Unsafe version of temporalLayerCount.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoEncodeAV1RateControlInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoEncodeAV1RateControlInfoKHR	set(int sType, long pNext, int flags, int gopFrameCount, int keyFramePeriod, int consecutiveBipredictiveFrameCount, int temporalLayerCount)	Initializes this struct with the specified values.
VkVideoEncodeAV1RateControlInfoKHR	set(VkVideoEncodeAV1RateControlInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeAV1RateControlInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeAV1RateControlInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_AV1_RATE_CONTROL_INFO_KHR value to the sType() field.
int	temporalLayerCount()	specifies the number of AV1 temporal layers that the application intends to use.
VkVideoEncodeAV1RateControlInfoKHR	temporalLayerCount(int value)	Sets the specified value to the temporalLayerCount() field.

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.

FLAGS

public static final int FLAGS

The struct member offsets.

GOPFRAMECOUNT

public static final int GOPFRAMECOUNT

The struct member offsets.

KEYFRAMEPERIOD

public static final int KEYFRAMEPERIOD

The struct member offsets.

CONSECUTIVEBIPREDICTIVEFRAMECOUNT

public static final int CONSECUTIVEBIPREDICTIVEFRAMECOUNT

The struct member offsets.

TEMPORALLAYERCOUNT

public static final int TEMPORALLAYERCOUNT

The struct member offsets.

Constructor Details

VkVideoEncodeAV1RateControlInfoKHR

public VkVideoEncodeAV1RateControlInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

a bitmask of VkVideoEncodeAV1RateControlFlagBitsKHR specifying AV1 rate control flags.

gopFrameCount

public int gopFrameCount()

the number of frames within a group of pictures (GOP) intended to be used by the application. If it is set to 0, the rate control algorithm may assume an implementation-dependent GOP length. If it is set to UINT32_MAX, the GOP length is treated as infinite.

keyFramePeriod

public int keyFramePeriod()

the interval, in terms of number of frames, between two frames with the AV1 frame type STD_VIDEO_AV1_FRAME_TYPE_KEY (see key frame period). If it is set to 0, the rate control algorithm may assume an implementation-dependent key frame period. If it is set to UINT32_MAX, the key frame period is treated as infinite.

consecutiveBipredictiveFrameCount

public int consecutiveBipredictiveFrameCount()

the number of consecutive frames encoded with VIDEO_ENCODE_AV1_RATE_CONTROL_GROUP_BIPREDICTIVE_KHR between frames encoded with other rate control groups within the GOP.

temporalLayerCount

public int temporalLayerCount()

specifies the number of AV1 temporal layers that the application intends to use.

sType

public VkVideoEncodeAV1RateControlInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeAV1RateControlInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_AV1_RATE_CONTROL_INFO_KHR value to the sType() field.

pNext

public VkVideoEncodeAV1RateControlInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkVideoEncodeAV1RateControlInfoKHR flags(int value)

Sets the specified value to the flags() field.

gopFrameCount

public VkVideoEncodeAV1RateControlInfoKHR gopFrameCount(int value)

Sets the specified value to the gopFrameCount() field.

keyFramePeriod

public VkVideoEncodeAV1RateControlInfoKHR keyFramePeriod(int value)

Sets the specified value to the keyFramePeriod() field.

consecutiveBipredictiveFrameCount

public VkVideoEncodeAV1RateControlInfoKHR consecutiveBipredictiveFrameCount(int value)

Sets the specified value to the consecutiveBipredictiveFrameCount() field.

temporalLayerCount

public VkVideoEncodeAV1RateControlInfoKHR temporalLayerCount(int value)

Sets the specified value to the temporalLayerCount() field.

set

public VkVideoEncodeAV1RateControlInfoKHR set(int sType,
 long pNext,
 int flags,
 int gopFrameCount,
 int keyFramePeriod,
 int consecutiveBipredictiveFrameCount,
 int temporalLayerCount)

Initializes this struct with the specified values.

set

public VkVideoEncodeAV1RateControlInfoKHR set(VkVideoEncodeAV1RateControlInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeAV1RateControlInfoKHR malloc()

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

calloc

public static VkVideoEncodeAV1RateControlInfoKHR calloc()

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

create

public static VkVideoEncodeAV1RateControlInfoKHR create()

Returns a new VkVideoEncodeAV1RateControlInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeAV1RateControlInfoKHR create(long address)

Returns a new VkVideoEncodeAV1RateControlInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeAV1RateControlInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeAV1RateControlInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeAV1RateControlInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeAV1RateControlInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeAV1RateControlInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeAV1RateControlInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeAV1RateControlInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

ngopFrameCount

public static int ngopFrameCount(long struct)

Unsafe version of gopFrameCount().

nkeyFramePeriod

public static int nkeyFramePeriod(long struct)

Unsafe version of keyFramePeriod().

nconsecutiveBipredictiveFrameCount

public static int nconsecutiveBipredictiveFrameCount(long struct)

Unsafe version of consecutiveBipredictiveFrameCount().

ntemporalLayerCount

public static int ntemporalLayerCount(long struct)

Unsafe version of temporalLayerCount().

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

ngopFrameCount

public static void ngopFrameCount(long struct,
 int value)

Unsafe version of gopFrameCount.

nkeyFramePeriod

public static void nkeyFramePeriod(long struct,
 int value)

Unsafe version of keyFramePeriod.

nconsecutiveBipredictiveFrameCount

public static void nconsecutiveBipredictiveFrameCount(long struct,
 int value)

Unsafe version of consecutiveBipredictiveFrameCount.

ntemporalLayerCount

public static void ntemporalLayerCount(long struct,
 int value)

Unsafe version of temporalLayerCount.