Class VkVideoEncodeRateControlInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeRateControlInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeRateControlInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkVideoEncodeRateControlInfoKHR
extends Struct<VkVideoEncodeRateControlInfoKHR>
implements NativeResource

struct VkVideoEncodeRateControlInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkVideoEncodeRateControlFlagsKHR flags;
    VkVideoEncodeRateControlModeFlagBitsKHR rateControlMode;
    uint32_t layerCount;
    VkVideoEncodeRateControlLayerInfoKHR const * pLayers;
    uint32_t virtualBufferSizeInMs;
    uint32_t initialVirtualBufferSizeInMs;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeRateControlInfoKHR.Buffer	An array of VkVideoEncodeRateControlInfoKHR structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

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	INITIALVIRTUALBUFFERSIZEINMS	The struct member offsets.
static final int	LAYERCOUNT	The struct member offsets.
static final int	PLAYERS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	RATECONTROLMODE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	VIRTUALBUFFERSIZEINMS	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeRateControlInfoKHR	calloc()	Returns a new VkVideoEncodeRateControlInfoKHR instance allocated with memCalloc.
static VkVideoEncodeRateControlInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeRateControlInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeRateControlInfoKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkVideoEncodeRateControlInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeRateControlInfoKHR	calloc(MemoryStack stack)	Returns a new VkVideoEncodeRateControlInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeRateControlInfoKHR	create()	Returns a new VkVideoEncodeRateControlInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeRateControlInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeRateControlInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeRateControlInfoKHR	create(long address)	Returns a new VkVideoEncodeRateControlInfoKHR instance for the specified memory address.
static VkVideoEncodeRateControlInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeRateControlInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeRateControlInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeRateControlInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VkVideoEncodeRateControlInfoKHR	flags(int value)	Sets the specified value to the flags field.
int	initialVirtualBufferSizeInMs()
VkVideoEncodeRateControlInfoKHR	initialVirtualBufferSizeInMs(int value)	Sets the specified value to the initialVirtualBufferSizeInMs field.
int	layerCount()
static VkVideoEncodeRateControlInfoKHR	malloc()	Returns a new VkVideoEncodeRateControlInfoKHR instance allocated with memAlloc.
static VkVideoEncodeRateControlInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeRateControlInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeRateControlInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkVideoEncodeRateControlInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeRateControlInfoKHR	malloc(MemoryStack stack)	Returns a new VkVideoEncodeRateControlInfoKHR 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 int	ninitialVirtualBufferSizeInMs(long struct)	Unsafe version of initialVirtualBufferSizeInMs().
static void	ninitialVirtualBufferSizeInMs(long struct, int value)	Unsafe version of initialVirtualBufferSizeInMs.
static int	nlayerCount(long struct)	Unsafe version of layerCount().
static void	nlayerCount(long struct, int value)	Sets the specified value to the layerCount field of the specified struct.
static @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer	npLayers(long struct)	Unsafe version of pLayers().
static void	npLayers(long struct, @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer value)	Unsafe version of pLayers.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nrateControlMode(long struct)	Unsafe version of rateControlMode().
static void	nrateControlMode(long struct, int value)	Unsafe version of rateControlMode.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nvirtualBufferSizeInMs(long struct)	Unsafe version of virtualBufferSizeInMs().
static void	nvirtualBufferSizeInMs(long struct, int value)	Unsafe version of virtualBufferSizeInMs.
@Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer	pLayers()
VkVideoEncodeRateControlInfoKHR	pLayers(@Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer value)	Sets the address of the specified VkVideoEncodeRateControlLayerInfoKHR.Buffer to the pLayers field.
long	pNext()
VkVideoEncodeRateControlInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
int	rateControlMode()
VkVideoEncodeRateControlInfoKHR	rateControlMode(int value)	Sets the specified value to the rateControlMode field.
VkVideoEncodeRateControlInfoKHR	set(int sType, long pNext, int flags, int rateControlMode, @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayers, int virtualBufferSizeInMs, int initialVirtualBufferSizeInMs)	Initializes this struct with the specified values.
VkVideoEncodeRateControlInfoKHR	set(VkVideoEncodeRateControlInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkVideoEncodeRateControlInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkVideoEncodeRateControlInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	virtualBufferSizeInMs()
VkVideoEncodeRateControlInfoKHR	virtualBufferSizeInMs(int value)	Sets the specified value to the virtualBufferSizeInMs field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

RATECONTROLMODE

public static final int RATECONTROLMODE

The struct member offsets.

LAYERCOUNT

public static final int LAYERCOUNT

The struct member offsets.

PLAYERS

public static final int PLAYERS

The struct member offsets.

VIRTUALBUFFERSIZEINMS

public static final int VIRTUALBUFFERSIZEINMS

The struct member offsets.

INITIALVIRTUALBUFFERSIZEINMS

public static final int INITIALVIRTUALBUFFERSIZEINMS

The struct member offsets.

Constructor Details

VkVideoEncodeRateControlInfoKHR

public VkVideoEncodeRateControlInfoKHR(ByteBuffer container)

Creates a VkVideoEncodeRateControlInfoKHR 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkVideoEncodeRateControlInfoKHR>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

flags

@NativeType("VkVideoEncodeRateControlFlagsKHR")
public int flags()

Returns:

the value of the flags field.

rateControlMode

@NativeType("VkVideoEncodeRateControlModeFlagBitsKHR")
public int rateControlMode()

Returns:

the value of the rateControlMode field.

layerCount

@NativeType("uint32_t")
public int layerCount()

Returns:

the value of the layerCount field.

pLayers

@NativeType("VkVideoEncodeRateControlLayerInfoKHR const *")
public @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayers()

Returns:

a VkVideoEncodeRateControlLayerInfoKHR.Buffer view of the struct array pointed to by the pLayers field.

virtualBufferSizeInMs

@NativeType("uint32_t")
public int virtualBufferSizeInMs()

Returns:

the value of the virtualBufferSizeInMs field.

initialVirtualBufferSizeInMs

@NativeType("uint32_t")
public int initialVirtualBufferSizeInMs()

Returns:

the value of the initialVirtualBufferSizeInMs field.

sType

public VkVideoEncodeRateControlInfoKHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkVideoEncodeRateControlInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR value to the sType field.

pNext

public VkVideoEncodeRateControlInfoKHR pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

flags

public VkVideoEncodeRateControlInfoKHR flags(@NativeType("VkVideoEncodeRateControlFlagsKHR")
 int value)

Sets the specified value to the flags field.

rateControlMode

public VkVideoEncodeRateControlInfoKHR rateControlMode(@NativeType("VkVideoEncodeRateControlModeFlagBitsKHR")
 int value)

Sets the specified value to the rateControlMode field.

pLayers

public VkVideoEncodeRateControlInfoKHR pLayers(@NativeType("VkVideoEncodeRateControlLayerInfoKHR const *")
 @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer value)

Sets the address of the specified VkVideoEncodeRateControlLayerInfoKHR.Buffer to the pLayers field.

virtualBufferSizeInMs

public VkVideoEncodeRateControlInfoKHR virtualBufferSizeInMs(@NativeType("uint32_t")
 int value)

Sets the specified value to the virtualBufferSizeInMs field.

initialVirtualBufferSizeInMs

public VkVideoEncodeRateControlInfoKHR initialVirtualBufferSizeInMs(@NativeType("uint32_t")
 int value)

Sets the specified value to the initialVirtualBufferSizeInMs field.

set

public VkVideoEncodeRateControlInfoKHR set(int sType,
 long pNext,
 int flags,
 int rateControlMode,
 @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayers,
 int virtualBufferSizeInMs,
 int initialVirtualBufferSizeInMs)

Initializes this struct with the specified values.

set

public VkVideoEncodeRateControlInfoKHR set(VkVideoEncodeRateControlInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeRateControlInfoKHR malloc()

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

calloc

public static VkVideoEncodeRateControlInfoKHR calloc()

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

create

public static VkVideoEncodeRateControlInfoKHR create()

Returns a new VkVideoEncodeRateControlInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeRateControlInfoKHR create(long address)

Returns a new VkVideoEncodeRateControlInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeRateControlInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeRateControlInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeRateControlInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeRateControlInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeRateControlInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeRateControlInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeRateControlInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoEncodeRateControlInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkVideoEncodeRateControlInfoKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkVideoEncodeRateControlInfoKHR.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkVideoEncodeRateControlInfoKHR.Buffer calloc(int capacity,
 MemoryStack stack)

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

nrateControlMode

public static int nrateControlMode(long struct)

Unsafe version of rateControlMode().

nlayerCount

public static int nlayerCount(long struct)

Unsafe version of layerCount().

npLayers

public static @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer npLayers(long struct)

Unsafe version of pLayers().

nvirtualBufferSizeInMs

public static int nvirtualBufferSizeInMs(long struct)

Unsafe version of virtualBufferSizeInMs().

ninitialVirtualBufferSizeInMs

public static int ninitialVirtualBufferSizeInMs(long struct)

Unsafe version of initialVirtualBufferSizeInMs().

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.

nrateControlMode

public static void nrateControlMode(long struct,
 int value)

Unsafe version of rateControlMode.

nlayerCount

public static void nlayerCount(long struct,
 int value)

Sets the specified value to the layerCount field of the specified struct.

npLayers

public static void npLayers(long struct,
 @Nullable VkVideoEncodeRateControlLayerInfoKHR.Buffer value)

Unsafe version of pLayers.

nvirtualBufferSizeInMs

public static void nvirtualBufferSizeInMs(long struct,
 int value)

Unsafe version of virtualBufferSizeInMs.

ninitialVirtualBufferSizeInMs

public static void ninitialVirtualBufferSizeInMs(long struct,
 int value)

Unsafe version of initialVirtualBufferSizeInMs.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate