Package org.lwjgl.vulkan

Class VkVideoEncodeQualityLevelInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeQualityLevelInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeQualityLevelInfoKHR

All Implemented Interfaces:

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

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

Structure specifying used video encode quality level.

Description

This structure can be specified in the following places:

• In the pNext chain of VkVideoSessionParametersCreateInfoKHR to specify the video encode quality level to use for a video session parameters object created for a video encode session. If no instance of this structure is included in the pNext chain of VkVideoSessionParametersCreateInfoKHR, then the video session parameters object is created with a video encode quality level of zero.
• In the pNext chain of VkVideoCodingControlInfoKHR to change the video encode quality level state of the bound video session.

Valid Usage

• qualityLevel must be less than VkVideoEncodeCapabilitiesKHR::maxQualityLevels, as returned by GetPhysicalDeviceVideoCapabilitiesKHR for the used video profile

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_QUALITY_LEVEL_INFO_KHR

Layout

 struct VkVideoEncodeQualityLevelInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t qualityLevel();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeQualityLevelInfoKHR.Buffer	An array of VkVideoEncodeQualityLevelInfoKHR 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	QUALITYLEVEL	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
VkVideoEncodeQualityLevelInfoKHR(ByteBuffer container)	Creates a VkVideoEncodeQualityLevelInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeQualityLevelInfoKHR	calloc()	Returns a new VkVideoEncodeQualityLevelInfoKHR instance allocated with memCalloc.
static VkVideoEncodeQualityLevelInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeQualityLevelInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeQualityLevelInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQualityLevelInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeQualityLevelInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQualityLevelInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeQualityLevelInfoKHR	create()	Returns a new VkVideoEncodeQualityLevelInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeQualityLevelInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeQualityLevelInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeQualityLevelInfoKHR	create(long address)	Returns a new VkVideoEncodeQualityLevelInfoKHR instance for the specified memory address.
static VkVideoEncodeQualityLevelInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeQualityLevelInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeQualityLevelInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeQualityLevelInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoEncodeQualityLevelInfoKHR	malloc()	Returns a new VkVideoEncodeQualityLevelInfoKHR instance allocated with memAlloc.
static VkVideoEncodeQualityLevelInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeQualityLevelInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeQualityLevelInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQualityLevelInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeQualityLevelInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQualityLevelInfoKHR 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	nqualityLevel(long struct)	Unsafe version of qualityLevel().
static void	nqualityLevel(long struct, int value)	Unsafe version of qualityLevel.
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.
VkVideoEncodeQualityLevelInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
int	qualityLevel()	the used video encode quality level.
VkVideoEncodeQualityLevelInfoKHR	qualityLevel(int value)	Sets the specified value to the qualityLevel() field.
VkVideoEncodeQualityLevelInfoKHR	set(int sType, long pNext, int qualityLevel)	Initializes this struct with the specified values.
VkVideoEncodeQualityLevelInfoKHR	set(VkVideoEncodeQualityLevelInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeQualityLevelInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeQualityLevelInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_QUALITY_LEVEL_INFO_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.

QUALITYLEVEL

public static final int QUALITYLEVEL

The struct member offsets.

Constructor Details

VkVideoEncodeQualityLevelInfoKHR

public VkVideoEncodeQualityLevelInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

qualityLevel

public int qualityLevel()

the used video encode quality level.

sType

public VkVideoEncodeQualityLevelInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeQualityLevelInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_QUALITY_LEVEL_INFO_KHR value to the sType() field.

pNext

public VkVideoEncodeQualityLevelInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

qualityLevel

public VkVideoEncodeQualityLevelInfoKHR qualityLevel(int value)

Sets the specified value to the qualityLevel() field.

set

public VkVideoEncodeQualityLevelInfoKHR set(int sType,
 long pNext,
 int qualityLevel)

Initializes this struct with the specified values.

set

public VkVideoEncodeQualityLevelInfoKHR set(VkVideoEncodeQualityLevelInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeQualityLevelInfoKHR malloc()

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

calloc

public static VkVideoEncodeQualityLevelInfoKHR calloc()

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

create

public static VkVideoEncodeQualityLevelInfoKHR create()

Returns a new VkVideoEncodeQualityLevelInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeQualityLevelInfoKHR create(long address)

Returns a new VkVideoEncodeQualityLevelInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeQualityLevelInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeQualityLevelInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeQualityLevelInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeQualityLevelInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeQualityLevelInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeQualityLevelInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeQualityLevelInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nqualityLevel

public static int nqualityLevel(long struct)

Unsafe version of qualityLevel().

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.

nqualityLevel

public static void nqualityLevel(long struct,
 int value)

Unsafe version of qualityLevel.