Package org.lwjgl.vulkan

Class VkVideoCodingControlInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoCodingControlInfoKHR>

org.lwjgl.vulkan.VkVideoCodingControlInfoKHR

All Implemented Interfaces:

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

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

Structure specifying video coding control parameters.

Valid Usage

• If flags includes VIDEO_CODING_CONTROL_ENCODE_RATE_CONTROL_BIT_KHR, then the pNext chain must include a VkVideoEncodeRateControlInfoKHR structure
• If flags includes VIDEO_CODING_CONTROL_ENCODE_QUALITY_LEVEL_BIT_KHR, then the pNext chain must include a VkVideoEncodeQualityLevelInfoKHR structure

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_CODING_CONTROL_INFO_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 VkVideoEncodeAV1RateControlInfoKHR, VkVideoEncodeH264RateControlInfoKHR, VkVideoEncodeH265RateControlInfoKHR, VkVideoEncodeQualityLevelInfoKHR, or VkVideoEncodeRateControlInfoKHR
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of VkVideoCodingControlFlagBitsKHR values
• flags must not be 0

See Also

CmdControlVideoCodingKHR

Layout

 struct VkVideoCodingControlInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkVideoCodingControlFlagsKHR flags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoCodingControlInfoKHR.Buffer	An array of VkVideoCodingControlInfoKHR 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	FLAGS	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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkVideoCodingControlInfoKHR(ByteBuffer container)	Creates a VkVideoCodingControlInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoCodingControlInfoKHR	calloc()	Returns a new VkVideoCodingControlInfoKHR instance allocated with memCalloc.
static VkVideoCodingControlInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoCodingControlInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoCodingControlInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoCodingControlInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoCodingControlInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoCodingControlInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoCodingControlInfoKHR	create()	Returns a new VkVideoCodingControlInfoKHR instance allocated with BufferUtils.
static VkVideoCodingControlInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoCodingControlInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoCodingControlInfoKHR	create(long address)	Returns a new VkVideoCodingControlInfoKHR instance for the specified memory address.
static VkVideoCodingControlInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoCodingControlInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoCodingControlInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoCodingControlInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask of VkVideoCodingControlFlagsKHR specifying control flags.
VkVideoCodingControlInfoKHR	flags(int value)	Sets the specified value to the flags() field.
static VkVideoCodingControlInfoKHR	malloc()	Returns a new VkVideoCodingControlInfoKHR instance allocated with memAlloc.
static VkVideoCodingControlInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoCodingControlInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoCodingControlInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoCodingControlInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoCodingControlInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoCodingControlInfoKHR instance allocated on the specified MemoryStack.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoCodingControlInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoCodingControlInfoKHR	pNext(VkVideoEncodeAV1RateControlInfoKHR value)	Prepends the specified VkVideoEncodeAV1RateControlInfoKHR value to the pNext chain.
VkVideoCodingControlInfoKHR	pNext(VkVideoEncodeH264RateControlInfoKHR value)	Prepends the specified VkVideoEncodeH264RateControlInfoKHR value to the pNext chain.
VkVideoCodingControlInfoKHR	pNext(VkVideoEncodeH265RateControlInfoKHR value)	Prepends the specified VkVideoEncodeH265RateControlInfoKHR value to the pNext chain.
VkVideoCodingControlInfoKHR	pNext(VkVideoEncodeQualityLevelInfoKHR value)	Prepends the specified VkVideoEncodeQualityLevelInfoKHR value to the pNext chain.
VkVideoCodingControlInfoKHR	pNext(VkVideoEncodeRateControlInfoKHR value)	Prepends the specified VkVideoEncodeRateControlInfoKHR value to the pNext chain.
VkVideoCodingControlInfoKHR	set(int sType, long pNext, int flags)	Initializes this struct with the specified values.
VkVideoCodingControlInfoKHR	set(VkVideoCodingControlInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoCodingControlInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoCodingControlInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_CODING_CONTROL_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.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

VkVideoCodingControlInfoKHR

public VkVideoCodingControlInfoKHR(ByteBuffer container)

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

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 VkVideoCodingControlFlagsKHR specifying control flags.

sType

public VkVideoCodingControlInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoCodingControlInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_CODING_CONTROL_INFO_KHR value to the sType() field.

pNext

public VkVideoCodingControlInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkVideoCodingControlInfoKHR pNext(VkVideoEncodeAV1RateControlInfoKHR value)

Prepends the specified VkVideoEncodeAV1RateControlInfoKHR value to the pNext chain.

pNext

public VkVideoCodingControlInfoKHR pNext(VkVideoEncodeH264RateControlInfoKHR value)

Prepends the specified VkVideoEncodeH264RateControlInfoKHR value to the pNext chain.

pNext

public VkVideoCodingControlInfoKHR pNext(VkVideoEncodeH265RateControlInfoKHR value)

Prepends the specified VkVideoEncodeH265RateControlInfoKHR value to the pNext chain.

pNext

public VkVideoCodingControlInfoKHR pNext(VkVideoEncodeQualityLevelInfoKHR value)

Prepends the specified VkVideoEncodeQualityLevelInfoKHR value to the pNext chain.

pNext

public VkVideoCodingControlInfoKHR pNext(VkVideoEncodeRateControlInfoKHR value)

Prepends the specified VkVideoEncodeRateControlInfoKHR value to the pNext chain.

flags

public VkVideoCodingControlInfoKHR flags(int value)

Sets the specified value to the flags() field.

set

public VkVideoCodingControlInfoKHR set(int sType,
 long pNext,
 int flags)

Initializes this struct with the specified values.

set

public VkVideoCodingControlInfoKHR set(VkVideoCodingControlInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoCodingControlInfoKHR malloc()

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

calloc

public static VkVideoCodingControlInfoKHR calloc()

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

create

public static VkVideoCodingControlInfoKHR create()

Returns a new VkVideoCodingControlInfoKHR instance allocated with BufferUtils.

create

public static VkVideoCodingControlInfoKHR create(long address)

Returns a new VkVideoCodingControlInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoCodingControlInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoCodingControlInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoCodingControlInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoCodingControlInfoKHR.Buffer create(int capacity)

Returns a new VkVideoCodingControlInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoCodingControlInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoCodingControlInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.