Package org.lwjgl.vulkan

Class VkVideoEncodeQualityLevelPropertiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeQualityLevelPropertiesKHR>

org.lwjgl.vulkan.VkVideoEncodeQualityLevelPropertiesKHR

All Implemented Interfaces:

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

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

Structure describing the video encode quality level properties.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_QUALITY_LEVEL_PROPERTIES_KHR
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkVideoEncodeAV1QualityLevelPropertiesKHR, VkVideoEncodeH264QualityLevelPropertiesKHR, or VkVideoEncodeH265QualityLevelPropertiesKHR
• The sType value of each struct in the pNext chain must be unique

See Also

GetPhysicalDeviceVideoEncodeQualityLevelPropertiesKHR

Layout

 struct VkVideoEncodeQualityLevelPropertiesKHR {
     VkStructureType sType();
     void * pNext();
     VkVideoEncodeRateControlModeFlagBitsKHR preferredRateControlMode();
     uint32_t preferredRateControlLayerCount();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeQualityLevelPropertiesKHR	calloc()	Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated with memCalloc.
static VkVideoEncodeQualityLevelPropertiesKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeQualityLevelPropertiesKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeQualityLevelPropertiesKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeQualityLevelPropertiesKHR	create()	Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated with BufferUtils.
static VkVideoEncodeQualityLevelPropertiesKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeQualityLevelPropertiesKHR	create(long address)	Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance for the specified memory address.
static VkVideoEncodeQualityLevelPropertiesKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeQualityLevelPropertiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeQualityLevelPropertiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoEncodeQualityLevelPropertiesKHR	malloc()	Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated with memAlloc.
static VkVideoEncodeQualityLevelPropertiesKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeQualityLevelPropertiesKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeQualityLevelPropertiesKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQualityLevelPropertiesKHR 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 int	npreferredRateControlLayerCount(long struct)	Unsafe version of preferredRateControlLayerCount().
static int	npreferredRateControlMode(long struct)	Unsafe version of preferredRateControlMode().
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.
VkVideoEncodeQualityLevelPropertiesKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoEncodeQualityLevelPropertiesKHR	pNext(VkVideoEncodeAV1QualityLevelPropertiesKHR value)	Prepends the specified VkVideoEncodeAV1QualityLevelPropertiesKHR value to the pNext chain.
VkVideoEncodeQualityLevelPropertiesKHR	pNext(VkVideoEncodeH264QualityLevelPropertiesKHR value)	Prepends the specified VkVideoEncodeH264QualityLevelPropertiesKHR value to the pNext chain.
VkVideoEncodeQualityLevelPropertiesKHR	pNext(VkVideoEncodeH265QualityLevelPropertiesKHR value)	Prepends the specified VkVideoEncodeH265QualityLevelPropertiesKHR value to the pNext chain.
int	preferredRateControlLayerCount()	indicates the preferred number of rate control layers to use with the video encode quality level.
int	preferredRateControlMode()	a VkVideoEncodeRateControlModeFlagBitsKHR value indicating the preferred rate control mode to use with the video encode quality level.
VkVideoEncodeQualityLevelPropertiesKHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkVideoEncodeQualityLevelPropertiesKHR	set(VkVideoEncodeQualityLevelPropertiesKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeQualityLevelPropertiesKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeQualityLevelPropertiesKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_QUALITY_LEVEL_PROPERTIES_KHR value to the sType() 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.

PREFERREDRATECONTROLMODE

public static final int PREFERREDRATECONTROLMODE

The struct member offsets.

PREFERREDRATECONTROLLAYERCOUNT

public static final int PREFERREDRATECONTROLLAYERCOUNT

The struct member offsets.

Constructor Details

VkVideoEncodeQualityLevelPropertiesKHR

public VkVideoEncodeQualityLevelPropertiesKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

preferredRateControlMode

public int preferredRateControlMode()

a VkVideoEncodeRateControlModeFlagBitsKHR value indicating the preferred rate control mode to use with the video encode quality level.

preferredRateControlLayerCount

public int preferredRateControlLayerCount()

indicates the preferred number of rate control layers to use with the video encode quality level.

sType

public VkVideoEncodeQualityLevelPropertiesKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeQualityLevelPropertiesKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_QUALITY_LEVEL_PROPERTIES_KHR value to the sType() field.

pNext

public VkVideoEncodeQualityLevelPropertiesKHR pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkVideoEncodeQualityLevelPropertiesKHR pNext(VkVideoEncodeAV1QualityLevelPropertiesKHR value)

Prepends the specified VkVideoEncodeAV1QualityLevelPropertiesKHR value to the pNext chain.

pNext

public VkVideoEncodeQualityLevelPropertiesKHR pNext(VkVideoEncodeH264QualityLevelPropertiesKHR value)

Prepends the specified VkVideoEncodeH264QualityLevelPropertiesKHR value to the pNext chain.

pNext

public VkVideoEncodeQualityLevelPropertiesKHR pNext(VkVideoEncodeH265QualityLevelPropertiesKHR value)

Prepends the specified VkVideoEncodeH265QualityLevelPropertiesKHR value to the pNext chain.

set

public VkVideoEncodeQualityLevelPropertiesKHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkVideoEncodeQualityLevelPropertiesKHR set(VkVideoEncodeQualityLevelPropertiesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeQualityLevelPropertiesKHR malloc()

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

calloc

public static VkVideoEncodeQualityLevelPropertiesKHR calloc()

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

create

public static VkVideoEncodeQualityLevelPropertiesKHR create()

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeQualityLevelPropertiesKHR create(long address)

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeQualityLevelPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeQualityLevelPropertiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeQualityLevelPropertiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeQualityLevelPropertiesKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeQualityLevelPropertiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeQualityLevelPropertiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npreferredRateControlMode

public static int npreferredRateControlMode(long struct)

Unsafe version of preferredRateControlMode().

npreferredRateControlLayerCount

public static int npreferredRateControlLayerCount(long struct)

Unsafe version of preferredRateControlLayerCount().

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.