Structure to set encode stream rate control parameters.

Description

Including this structure in the pNext chain of VkVideoCodingControlInfoKHR and including VIDEO_CODING_CONTROL_ENCODE_RATE_CONTROL_BIT_KHR in VkVideoCodingControlInfoKHR::flags will define stream rate control settings for video encoding.

Additional structures providing codec-specific rate control parameters may need to be included in the pNext chain of VkVideoCodingControlInfoKHR depending on the codec profile the bound video session was created with and the parameters specified in VkVideoEncodeRateControlInfoKHR (see Video Coding Control).

To ensure that the video session is properly initialized with stream-level rate control settings, the application must call CmdControlVideoCodingKHR with stream-level rate control settings at least once in execution order before the first CmdEncodeVideoKHR command that is executed after video session reset. If not provided, default implementation-specific stream rate control settings will be used.

Stream rate control settings can also be re-initialized during an active video encoding session. The re-initialization takes effect whenever the VkVideoEncodeRateControlInfoKHR structure is included in the pNext chain of the VkVideoCodingControlInfoKHR structure in the call to CmdControlVideoCodingKHR, and only impacts CmdEncodeVideoKHR operations that follow in execution order.

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR
flags must be 0
If rateControlMode is not 0, rateControlMode must be a valid VkVideoEncodeRateControlModeFlagBitsKHR value
If layerCount is not 0, pLayers must be a valid pointer to an array of layerCount valid VkVideoEncodeRateControlLayerInfoKHR structures

Layout


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

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FLAGS The struct member offsets.
public static final int	INITIALVIRTUALBUFFERSIZEINMS The struct member offsets.
public static final int	LAYERCOUNT The struct member offsets.
public static final int	PLAYERS The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	RATECONTROLMODE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.
public static final int	VIRTUALBUFFERSIZEINMS The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkVideoEncodeRateControlInfoKHR(long address, ByteBuffer container)
public	VkVideoEncodeRateControlInfoKHR(ByteBuffer container) Creates a `VkVideoEncodeRateControlInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkVideoEncodeRateControlInfoKHR	calloc() Returns a new `VkVideoEncodeRateControlInfoKHR` instance allocated with `memCalloc`.
public static VkVideoEncodeRateControlInfoKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated with `memCalloc`.
public static VkVideoEncodeRateControlInfoKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeRateControlInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkVideoEncodeRateControlInfoKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkVideoEncodeRateControlInfoKHR	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkVideoEncodeRateControlInfoKHR	create() Returns a new `VkVideoEncodeRateControlInfoKHR` instance allocated with `BufferUtils`.
public static VkVideoEncodeRateControlInfoKHR	create(long address) Returns a new `VkVideoEncodeRateControlInfoKHR` instance for the specified memory address.
public static VkVideoEncodeRateControlInfoKHR.Buffer	create(int the buffer capacity capacity) Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated with `BufferUtils`.
public static VkVideoEncodeRateControlInfoKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkVideoEncodeRateControlInfoKHR.Buffer` instance at the specified memory.
public static VkVideoEncodeRateControlInfoKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkVideoEncodeRateControlInfoKHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() reserved for future use.
public VkVideoEncodeRateControlInfoKHR	flags(int value) Sets the specified value to the `flags` field.
public int	initialVirtualBufferSizeInMs() the initial occupancy in milliseconds of the virtual buffer in the leaky bucket model.
public VkVideoEncodeRateControlInfoKHR	initialVirtualBufferSizeInMs(int value) Sets the specified value to the `initialVirtualBufferSizeInMs` field.
public int	layerCount() specifies the number of rate control layers in the video encode stream.
public static VkVideoEncodeRateControlInfoKHR	malloc() Returns a new `VkVideoEncodeRateControlInfoKHR` instance allocated with `memAlloc`.
public static VkVideoEncodeRateControlInfoKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated with `memAlloc`.
public static VkVideoEncodeRateControlInfoKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeRateControlInfoKHR` instance allocated on the specified `MemoryStack`.
public static VkVideoEncodeRateControlInfoKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static int	ninitialVirtualBufferSizeInMs(long struct) Unsafe version of `initialVirtualBufferSizeInMs`.
public static void	ninitialVirtualBufferSizeInMs(long struct, int value) Unsafe version of `initialVirtualBufferSizeInMs`.
public static int	nlayerCount(long struct) Unsafe version of `layerCount`.
public static void	nlayerCount(long struct, int value) Sets the specified value to the `layerCount` field of the specified `struct`.
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer	npLayers(long struct) Unsafe version of `pLayers`.
public static void	npLayers(long struct, VkVideoEncodeRateControlLayerInfoKHR.Buffer value) Unsafe version of `pLayers`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nrateControlMode(long struct) Unsafe version of `rateControlMode`.
public static void	nrateControlMode(long struct, int value) Unsafe version of `rateControlMode`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public static int	nvirtualBufferSizeInMs(long struct) Unsafe version of `virtualBufferSizeInMs`.
public static void	nvirtualBufferSizeInMs(long struct, int value) Unsafe version of `virtualBufferSizeInMs`.
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	pLayers() a pointer to an array of `VkVideoEncodeRateControlLayerInfoKHR` structures specifying the rate control configurations of `layerCount` rate control layers.
public VkVideoEncodeRateControlInfoKHR	pLayers(VkVideoEncodeRateControlLayerInfoKHR.Buffer value) Sets the address of the specified `VkVideoEncodeRateControlLayerInfoKHR.Buffer` to the `pLayers` field.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkVideoEncodeRateControlInfoKHR	pNext(long value) Sets the specified value to the `pNext` field.
public int	rateControlMode() a `VkVideoEncodeRateControlModeFlagBitsKHR` value specifying the encode stream rate control mode.
public VkVideoEncodeRateControlInfoKHR	rateControlMode(int value) Sets the specified value to the `rateControlMode` field.
public VkVideoEncodeRateControlInfoKHR	set(int sType, long pNext, int flags, int rateControlMode, VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayers, int virtualBufferSizeInMs, int initialVirtualBufferSizeInMs) Initializes this struct with the specified values.
public VkVideoEncodeRateControlInfoKHR	Returns: this struct set(VkVideoEncodeRateControlInfoKHR the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	sType() a `VkStructureType` value identifying this structure.
public VkVideoEncodeRateControlInfoKHR	sType(int value) Sets the specified value to the `sType` field.
public VkVideoEncodeRateControlInfoKHR	sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR` value to the `sType` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.
public int	virtualBufferSizeInMs() the leaky bucket model virtual buffer size in milliseconds, with respect to peak bitrate.
public VkVideoEncodeRateControlInfoKHR	virtualBufferSizeInMs(int value) Sets the specified value to the `virtualBufferSizeInMs` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

FLAGS	back to summary
public static final int FLAGS The struct member offsets.

INITIALVIRTUALBUFFERSIZEINMS	back to summary
public static final int INITIALVIRTUALBUFFERSIZEINMS The struct member offsets.

LAYERCOUNT	back to summary
public static final int LAYERCOUNT The struct member offsets.

PLAYERS	back to summary
public static final int PLAYERS The struct member offsets.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

RATECONTROLMODE	back to summary
public static final int RATECONTROLMODE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

VIRTUALBUFFERSIZEINMS	back to summary
public static final int VIRTUALBUFFERSIZEINMS The struct member offsets.

Constructor Detail

VkVideoEncodeRateControlInfoKHR	back to summary
protected VkVideoEncodeRateControlInfoKHR(long address, ByteBuffer container)

VkVideoEncodeRateControlInfoKHR back to summary

VkVideoEncodeRateControlInfoKHR	back to summary
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.

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 Detail

calloc	back to summary
public static VkVideoEncodeRateControlInfoKHR calloc() Returns a new `VkVideoEncodeRateControlInfoKHR` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkVideoEncodeRateControlInfoKHR.Buffer calloc(int capacity) Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkVideoEncodeRateControlInfoKHR.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
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:MemoryStack the stack from which to allocate

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:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
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:int the buffer capacity stack:MemoryStack the stack from which to allocate

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:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

create back to summary

create	back to summary
protected VkVideoEncodeRateControlInfoKHR create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkVideoEncodeRateControlInfoKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkVideoEncodeRateControlInfoKHR create() Returns a new `VkVideoEncodeRateControlInfoKHR` instance allocated with `BufferUtils`.

create	back to summary
public static VkVideoEncodeRateControlInfoKHR create(long address) Returns a new `VkVideoEncodeRateControlInfoKHR` instance for the specified memory address.

create back to summary

create	back to summary
public static VkVideoEncodeRateControlInfoKHR.Buffer create(int capacity) Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkVideoEncodeRateControlInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeRateControlInfoKHR.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkVideoEncodeRateControlInfoKHR.Buffer create(long address, int capacity) Create a `VkVideoEncodeRateControlInfoKHR.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkVideoEncodeRateControlInfoKHR.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkVideoEncodeRateControlInfoKHR createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkVideoEncodeRateControlInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkVideoEncodeRateControlInfoKHR.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

flags	back to summary
public int flags() reserved for future use. Annotations @NativeType:VkVideoEncodeRateControlFlagsKHR

flags

back to summary

public int flags()

reserved for future use.

Annotations

@NativeType:VkVideoEncodeRateControlFlagsKHR

flags	back to summary
public VkVideoEncodeRateControlInfoKHR flags(int value) Sets the specified value to the `flags` field.

initialVirtualBufferSizeInMs back to summary

initialVirtualBufferSizeInMs	back to summary
public int initialVirtualBufferSizeInMs() the initial occupancy in milliseconds of the virtual buffer in the leaky bucket model. Valid when rate control mode is `VIDEO_ENCODE_RATE_CONTROL_MODE_CBR_BIT_KHR` or `VIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR`. Annotations @NativeType:uint32_t

public int initialVirtualBufferSizeInMs()

the initial occupancy in milliseconds of the virtual buffer in the leaky bucket model. Valid when rate control mode is VIDEO_ENCODE_RATE_CONTROL_MODE_CBR_BIT_KHR or VIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR.

Annotations

@NativeType:uint32_t

initialVirtualBufferSizeInMs	back to summary
public VkVideoEncodeRateControlInfoKHR initialVirtualBufferSizeInMs(int value) Sets the specified value to the `initialVirtualBufferSizeInMs` field.

layerCount	back to summary
public int layerCount() specifies the number of rate control layers in the video encode stream. Annotations @NativeType:uint32_t

layerCount

back to summary

public int layerCount()

specifies the number of rate control layers in the video encode stream.

Annotations

@NativeType:uint32_t

malloc	back to summary
public static VkVideoEncodeRateControlInfoKHR malloc() Returns a new `VkVideoEncodeRateControlInfoKHR` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkVideoEncodeRateControlInfoKHR.Buffer malloc(int capacity) Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkVideoEncodeRateControlInfoKHR.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkVideoEncodeRateControlInfoKHR malloc(MemoryStack stack) Returns a new `VkVideoEncodeRateControlInfoKHR` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkVideoEncodeRateControlInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoEncodeRateControlInfoKHR instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkVideoEncodeRateControlInfoKHR.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

nflags	back to summary
public static int nflags(long struct) Unsafe version of `flags`.

nflags	back to summary
public static void nflags(long struct, int value) Unsafe version of `flags`.

ninitialVirtualBufferSizeInMs	back to summary
public static int ninitialVirtualBufferSizeInMs(long struct) Unsafe version of `initialVirtualBufferSizeInMs`.

ninitialVirtualBufferSizeInMs	back to summary
public static void ninitialVirtualBufferSizeInMs(long struct, int value) Unsafe version of `initialVirtualBufferSizeInMs`.

nlayerCount	back to summary
public static int nlayerCount(long struct) Unsafe version of `layerCount`.

nlayerCount	back to summary
public static void nlayerCount(long struct, int value) Sets the specified value to the `layerCount` field of the specified `struct`.

npLayers back to summary

npLayers	back to summary
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer npLayers(long struct) Unsafe version of `pLayers`. Annotations @Nullable

public static VkVideoEncodeRateControlLayerInfoKHR.Buffer npLayers(long struct)

Unsafe version of pLayers.

Annotations

@Nullable

npLayers	back to summary
public static void npLayers(long struct, VkVideoEncodeRateControlLayerInfoKHR.Buffer value) Unsafe version of `pLayers`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nrateControlMode	back to summary
public static int nrateControlMode(long struct) Unsafe version of `rateControlMode`.

nrateControlMode	back to summary
public static void nrateControlMode(long struct, int value) Unsafe version of `rateControlMode`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

nvirtualBufferSizeInMs	back to summary
public static int nvirtualBufferSizeInMs(long struct) Unsafe version of `virtualBufferSizeInMs`.

nvirtualBufferSizeInMs	back to summary
public static void nvirtualBufferSizeInMs(long struct, int value) Unsafe version of `virtualBufferSizeInMs`.

pLayers back to summary

public VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayers()

a pointer to an array of VkVideoEncodeRateControlLayerInfoKHR structures specifying the rate control configurations of layerCount rate control layers.

Annotations

@Nullable
@NativeType:VkVideoEncodeRateControlLayerInfoKHR const *

pLayers	back to summary
public VkVideoEncodeRateControlInfoKHR pLayers(VkVideoEncodeRateControlLayerInfoKHR.Buffer value) Sets the address of the specified `VkVideoEncodeRateControlLayerInfoKHR.Buffer` to the `pLayers` field.

pNext back to summary

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkVideoEncodeRateControlInfoKHR pNext(long value) Sets the specified value to the `pNext` field.

rateControlMode back to summary

public int rateControlMode()

a VkVideoEncodeRateControlModeFlagBitsKHR value specifying the encode stream rate control mode.

Annotations

@NativeType:VkVideoEncodeRateControlModeFlagBitsKHR

rateControlMode	back to summary
public VkVideoEncodeRateControlInfoKHR rateControlMode(int value) Sets the specified value to the `rateControlMode` field.

set	back to summary
public VkVideoEncodeRateControlInfoKHR set(int sType, long pNext, int flags, int rateControlMode, VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayers, int virtualBufferSizeInMs, int initialVirtualBufferSizeInMs) Initializes this struct with the specified values.

set

back to summary

public VkVideoEncodeRateControlInfoKHR set(VkVideoEncodeRateControlInfoKHR src)

Copies the specified struct data to this struct.

Parameters

src:VkVideoEncodeRateControlInfoKHR: the source struct

Returns:VkVideoEncodeRateControlInfoKHR

this struct

sizeof back to summary

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkVideoEncodeRateControlInfoKHR sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkVideoEncodeRateControlInfoKHR sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR` value to the `sType` field.

validate back to summary

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters

struct:long: the struct to validate

virtualBufferSizeInMs back to summary

public int virtualBufferSizeInMs()

the leaky bucket model virtual buffer size in milliseconds, with respect to peak bitrate. Valid when rate control mode is VIDEO_ENCODE_RATE_CONTROL_MODE_CBR_BIT_KHR or VIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR. For example, virtual buffer size is (virtualBufferSizeInMs × maxBitrate / 1000).

Annotations

@NativeType:uint32_t

virtualBufferSizeInMs	back to summary
public VkVideoEncodeRateControlInfoKHR virtualBufferSizeInMs(int value) Sets the specified value to the `virtualBufferSizeInMs` field.

org.lwjgl.vulkan back to summary

public Class VkVideoEncodeRateControlInfoKHR.Buffer

Class Inheritance

extends StructBuffer<VkVideoEncodeRateControlInfoKHR, VkVideoEncodeRateControlInfoKHR.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkVideoEncodeRateControlInfoKHR.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkVideoEncodeRateControlInfoKHR structs.

Field Summary

Modifier and Type	Field and Description
private static final VkVideoEncodeRateControlInfoKHR	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public int	Returns: the value of the `VkVideoEncodeRateControlInfoKHR#flags` field. flags()
public VkVideoEncodeRateControlInfoKHR.Buffer	flags(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#flags` field.
protected VkVideoEncodeRateControlInfoKHR	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VkVideoEncodeRateControlInfoKHR#initialVirtualBufferSizeInMs` field. initialVirtualBufferSizeInMs()
public VkVideoEncodeRateControlInfoKHR.Buffer	initialVirtualBufferSizeInMs(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#initialVirtualBufferSizeInMs` field.
public int	Returns: the value of the `VkVideoEncodeRateControlInfoKHR#layerCount` field. layerCount()
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	Returns: a `VkVideoEncodeRateControlLayerInfoKHR.Buffer` view of the struct array pointed to by the `VkVideoEncodeRateControlInfoKHR#pLayers` field. pLayers()
public VkVideoEncodeRateControlInfoKHR.Buffer	pLayers(VkVideoEncodeRateControlLayerInfoKHR.Buffer value) Sets the address of the specified `VkVideoEncodeRateControlLayerInfoKHR.Buffer` to the `VkVideoEncodeRateControlInfoKHR#pLayers` field.
public long	Returns: the value of the `VkVideoEncodeRateControlInfoKHR#pNext` field. pNext()
public VkVideoEncodeRateControlInfoKHR.Buffer	pNext(long value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#pNext` field.
public int	Returns: the value of the `VkVideoEncodeRateControlInfoKHR#rateControlMode` field. rateControlMode()
public VkVideoEncodeRateControlInfoKHR.Buffer	rateControlMode(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#rateControlMode` field.
protected VkVideoEncodeRateControlInfoKHR.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkVideoEncodeRateControlInfoKHR#sType` field. sType()
public VkVideoEncodeRateControlInfoKHR.Buffer	sType(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#sType` field.
public VkVideoEncodeRateControlInfoKHR.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR` value to the `VkVideoEncodeRateControlInfoKHR#sType` field.
public int	Returns: the value of the `VkVideoEncodeRateControlInfoKHR#virtualBufferSizeInMs` field. virtualBufferSizeInMs()
public VkVideoEncodeRateControlInfoKHR.Buffer	virtualBufferSizeInMs(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#virtualBufferSizeInMs` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkVideoEncodeRateControlInfoKHR ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkVideoEncodeRateControlInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkVideoEncodeRateControlInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flags	back to summary
public int flags() Returns:int the value of the `VkVideoEncodeRateControlInfoKHR#flags` field. Annotations @NativeType:VkVideoEncodeRateControlFlagsKHR

flags	back to summary
public VkVideoEncodeRateControlInfoKHR.Buffer flags(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#flags` field.

getElementFactory

back to summary

protected VkVideoEncodeRateControlInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

initialVirtualBufferSizeInMs	back to summary
public int initialVirtualBufferSizeInMs() Returns:int the value of the `VkVideoEncodeRateControlInfoKHR#initialVirtualBufferSizeInMs` field. Annotations @NativeType:uint32_t

initialVirtualBufferSizeInMs	back to summary
public VkVideoEncodeRateControlInfoKHR.Buffer initialVirtualBufferSizeInMs(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#initialVirtualBufferSizeInMs` field.

layerCount	back to summary
public int layerCount() Returns:int the value of the `VkVideoEncodeRateControlInfoKHR#layerCount` field. Annotations @NativeType:uint32_t

pLayers	back to summary
public VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayers() Returns:VkVideoEncodeRateControlLayerInfoKHR.Buffer a `VkVideoEncodeRateControlLayerInfoKHR.Buffer` view of the struct array pointed to by the `VkVideoEncodeRateControlInfoKHR#pLayers` field. Annotations @Nullable @NativeType:VkVideoEncodeRateControlLayerInfoKHR const *

pLayers	back to summary
public VkVideoEncodeRateControlInfoKHR.Buffer pLayers(VkVideoEncodeRateControlLayerInfoKHR.Buffer value) Sets the address of the specified `VkVideoEncodeRateControlLayerInfoKHR.Buffer` to the `VkVideoEncodeRateControlInfoKHR#pLayers` field.

pNext	back to summary
public long pNext() Returns:long the value of the `VkVideoEncodeRateControlInfoKHR#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkVideoEncodeRateControlInfoKHR.Buffer pNext(long value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#pNext` field.

rateControlMode	back to summary
public int rateControlMode() Returns:int the value of the `VkVideoEncodeRateControlInfoKHR#rateControlMode` field. Annotations @NativeType:VkVideoEncodeRateControlModeFlagBitsKHR

rateControlMode	back to summary
public VkVideoEncodeRateControlInfoKHR.Buffer rateControlMode(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#rateControlMode` field.

self

back to summary

protected VkVideoEncodeRateControlInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkVideoEncodeRateControlInfoKHR#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkVideoEncodeRateControlInfoKHR.Buffer sType(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#sType` field.

sType$Default	back to summary
public VkVideoEncodeRateControlInfoKHR.Buffer sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR` value to the `VkVideoEncodeRateControlInfoKHR#sType` field.

virtualBufferSizeInMs	back to summary
public int virtualBufferSizeInMs() Returns:int the value of the `VkVideoEncodeRateControlInfoKHR#virtualBufferSizeInMs` field. Annotations @NativeType:uint32_t

virtualBufferSizeInMs	back to summary
public VkVideoEncodeRateControlInfoKHR.Buffer virtualBufferSizeInMs(int value) Sets the specified value to the `VkVideoEncodeRateControlInfoKHR#virtualBufferSizeInMs` field.

public Class VkVideoEncodeRateControlInfoKHR

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkVideoEncodeRateControlInfoKHR.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail