Structure to set encode per-layer rate control parameters.

Description

A codec-specific structure specifying additional per-layer rate control settings must be chained to VkVideoEncodeRateControlLayerInfoKHR. If multiple rate control layers are enabled (VkVideoEncodeRateControlInfoKHR::layerCount is greater than 1), then the chained codec-specific extension structure also identifies the specific video coding layer its parent VkVideoEncodeRateControlLayerInfoKHR applies to. If multiple rate control layers are enabled, the number of rate control layers must match the number of video coding layers. The specification for an encode codec-specific extension would describe how multiple video coding layers are enabled for the corresponding codec.

Per-layer rate control settings for all enabled rate control layers must be initialized or re-initialized whenever stream rate control settings are provided via VkVideoEncodeRateControlInfoKHR. This is done by specifying settings for all enabled rate control layers in VkVideoEncodeRateControlInfoKHR::pLayers.

It is possible for an application to enable multiple video coding layers (via codec-specific extensions to encoding operations) while only enabling a single layer of rate control for the entire video stream. To achieve this, layerCount in VkVideoEncodeRateControlInfoKHR must be set to 1, and the single VkVideoEncodeRateControlLayerInfoKHR provided in pLayers would apply to all encoded segments of the video stream, regardless of which codec-defined video coding layer they belong to. In this case, the implementation decides bitrate distribution across video coding layers (if applicable to the specified stream rate control mode).

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_LAYER_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 VkVideoEncodeH264RateControlLayerInfoEXT or VkVideoEncodeH265RateControlLayerInfoEXT
The sType value of each struct in the pNext chain must be unique

Layout


struct VkVideoEncodeRateControlLayerInfoKHR {
    VkStructureType sType;
    void const * pNext;
    uint64_t averageBitrate;
    uint64_t maxBitrate;
    uint32_t frameRateNumerator;
    uint32_t frameRateDenominator;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	AVERAGEBITRATE The struct member offsets.
public static final int	FRAMERATEDENOMINATOR The struct member offsets.
public static final int	FRAMERATENUMERATOR The struct member offsets.
public static final int	MAXBITRATE The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public long	averageBitrate() the average bitrate in bits/second.
public VkVideoEncodeRateControlLayerInfoKHR	averageBitrate(long value) Sets the specified value to the `averageBitrate` field.
public static VkVideoEncodeRateControlLayerInfoKHR	calloc() Returns a new `VkVideoEncodeRateControlLayerInfoKHR` instance allocated with `memCalloc`.
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkVideoEncodeRateControlLayerInfoKHR.Buffer` instance allocated with `memCalloc`.
public static VkVideoEncodeRateControlLayerInfoKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeRateControlLayerInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeRateControlLayerInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkVideoEncodeRateControlLayerInfoKHR	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 VkVideoEncodeRateControlLayerInfoKHR	create() Returns a new `VkVideoEncodeRateControlLayerInfoKHR` instance allocated with `BufferUtils`.
public static VkVideoEncodeRateControlLayerInfoKHR	create(long address) Returns a new `VkVideoEncodeRateControlLayerInfoKHR` instance for the specified memory address.
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer	create(int the buffer capacity capacity) Returns a new `VkVideoEncodeRateControlLayerInfoKHR.Buffer` instance allocated with `BufferUtils`.
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkVideoEncodeRateControlLayerInfoKHR.Buffer` instance at the specified memory.
public static VkVideoEncodeRateControlLayerInfoKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	frameRateDenominator() the denominator of the frame rate.
public VkVideoEncodeRateControlLayerInfoKHR	frameRateDenominator(int value) Sets the specified value to the `frameRateDenominator` field.
public int	frameRateNumerator() the numerator of the frame rate.
public VkVideoEncodeRateControlLayerInfoKHR	frameRateNumerator(int value) Sets the specified value to the `frameRateNumerator` field.
public static VkVideoEncodeRateControlLayerInfoKHR	malloc() Returns a new `VkVideoEncodeRateControlLayerInfoKHR` instance allocated with `memAlloc`.
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkVideoEncodeRateControlLayerInfoKHR.Buffer` instance allocated with `memAlloc`.
public static VkVideoEncodeRateControlLayerInfoKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeRateControlLayerInfoKHR` instance allocated on the specified `MemoryStack`.
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeRateControlLayerInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
public long	maxBitrate() the peak bitrate in bits/second.
public VkVideoEncodeRateControlLayerInfoKHR	maxBitrate(long value) Sets the specified value to the `maxBitrate` field.
public static long	naverageBitrate(long struct) Unsafe version of `averageBitrate`.
public static void	naverageBitrate(long struct, long value) Unsafe version of `averageBitrate`.
public static int	nframeRateDenominator(long struct) Unsafe version of `frameRateDenominator`.
public static void	nframeRateDenominator(long struct, int value) Unsafe version of `frameRateDenominator`.
public static int	nframeRateNumerator(long struct) Unsafe version of `frameRateNumerator`.
public static void	nframeRateNumerator(long struct, int value) Unsafe version of `frameRateNumerator`.
public static long	nmaxBitrate(long struct) Unsafe version of `maxBitrate`.
public static void	nmaxBitrate(long struct, long value) Unsafe version of `maxBitrate`.
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	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() a pointer to a structure extending this structure.
public VkVideoEncodeRateControlLayerInfoKHR	pNext(long value) Sets the specified value to the `pNext` field.
public VkVideoEncodeRateControlLayerInfoKHR	pNext(VkVideoEncodeH264RateControlLayerInfoEXT value) Prepends the specified `VkVideoEncodeH264RateControlLayerInfoEXT` value to the `pNext` chain.
public VkVideoEncodeRateControlLayerInfoKHR	pNext(VkVideoEncodeH265RateControlLayerInfoEXT value) Prepends the specified `VkVideoEncodeH265RateControlLayerInfoEXT` value to the `pNext` chain.
public VkVideoEncodeRateControlLayerInfoKHR	set(int sType, long pNext, long averageBitrate, long maxBitrate, int frameRateNumerator, int frameRateDenominator) Initializes this struct with the specified values.
public VkVideoEncodeRateControlLayerInfoKHR	Returns: this struct set(VkVideoEncodeRateControlLayerInfoKHR 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 VkVideoEncodeRateControlLayerInfoKHR	sType(int value) Sets the specified value to the `sType` field.
public VkVideoEncodeRateControlLayerInfoKHR	sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_LAYER_INFO_KHR` value to the `sType` field.

Field Detail

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

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

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

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

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

PNEXT	back to summary
public static final int PNEXT 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.

Constructor Detail

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

VkVideoEncodeRateControlLayerInfoKHR back to summary

VkVideoEncodeRateControlLayerInfoKHR	back to summary
public VkVideoEncodeRateControlLayerInfoKHR(ByteBuffer container) Creates a `VkVideoEncodeRateControlLayerInfoKHR` 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 VkVideoEncodeRateControlLayerInfoKHR(ByteBuffer container)

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

averageBitrate back to summary

averageBitrate	back to summary
public long averageBitrate() the average bitrate in bits/second. 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:uint64_t

public long averageBitrate()

the average bitrate in bits/second. 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:uint64_t

averageBitrate	back to summary
public VkVideoEncodeRateControlLayerInfoKHR averageBitrate(long value) Sets the specified value to the `averageBitrate` field.

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

calloc back to summary

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

public static VkVideoEncodeRateControlLayerInfoKHR.Buffer calloc(int capacity)

Returns a new VkVideoEncodeRateControlLayerInfoKHR.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 VkVideoEncodeRateControlLayerInfoKHR calloc(MemoryStack stack) Returns a new `VkVideoEncodeRateControlLayerInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkVideoEncodeRateControlLayerInfoKHR calloc(MemoryStack stack)

Returns a new VkVideoEncodeRateControlLayerInfoKHR 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 VkVideoEncodeRateControlLayerInfoKHR.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkVideoEncodeRateControlLayerInfoKHR.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 VkVideoEncodeRateControlLayerInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkVideoEncodeRateControlLayerInfoKHR.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 VkVideoEncodeRateControlLayerInfoKHR 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 VkVideoEncodeRateControlLayerInfoKHR 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 VkVideoEncodeRateControlLayerInfoKHR create() Returns a new `VkVideoEncodeRateControlLayerInfoKHR` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkVideoEncodeRateControlLayerInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeRateControlLayerInfoKHR.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkVideoEncodeRateControlLayerInfoKHR.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 VkVideoEncodeRateControlLayerInfoKHR createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkVideoEncodeRateControlLayerInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

frameRateDenominator back to summary

frameRateDenominator	back to summary
public int frameRateDenominator() the denominator of the frame rate. 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 frameRateDenominator()

the denominator of the frame rate. 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

frameRateDenominator	back to summary
public VkVideoEncodeRateControlLayerInfoKHR frameRateDenominator(int value) Sets the specified value to the `frameRateDenominator` field.

frameRateNumerator back to summary

frameRateNumerator	back to summary
public int frameRateNumerator() the numerator of the frame rate. 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 frameRateNumerator()

the numerator of the frame rate. 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

frameRateNumerator	back to summary
public VkVideoEncodeRateControlLayerInfoKHR frameRateNumerator(int value) Sets the specified value to the `frameRateNumerator` field.

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

malloc back to summary

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

public static VkVideoEncodeRateControlLayerInfoKHR.Buffer malloc(int capacity)

Returns a new VkVideoEncodeRateControlLayerInfoKHR.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 VkVideoEncodeRateControlLayerInfoKHR malloc(MemoryStack stack) Returns a new `VkVideoEncodeRateControlLayerInfoKHR` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkVideoEncodeRateControlLayerInfoKHR malloc(MemoryStack stack)

Returns a new VkVideoEncodeRateControlLayerInfoKHR 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 VkVideoEncodeRateControlLayerInfoKHR.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkVideoEncodeRateControlLayerInfoKHR.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

maxBitrate back to summary

maxBitrate	back to summary
public long maxBitrate() the peak bitrate in bits/second. Valid when rate control mode is `VIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR`. Annotations @NativeType:uint64_t

public long maxBitrate()

the peak bitrate in bits/second. Valid when rate control mode is VIDEO_ENCODE_RATE_CONTROL_MODE_VBR_BIT_KHR.

Annotations

@NativeType:uint64_t

maxBitrate	back to summary
public VkVideoEncodeRateControlLayerInfoKHR maxBitrate(long value) Sets the specified value to the `maxBitrate` field.

naverageBitrate	back to summary
public static long naverageBitrate(long struct) Unsafe version of `averageBitrate`.

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

nframeRateDenominator	back to summary
public static int nframeRateDenominator(long struct) Unsafe version of `frameRateDenominator`.

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

nframeRateNumerator	back to summary
public static int nframeRateNumerator(long struct) Unsafe version of `frameRateNumerator`.

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

nmaxBitrate	back to summary
public static long nmaxBitrate(long struct) Unsafe version of `maxBitrate`.

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

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`.

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`.

pNext	back to summary
public long pNext() a pointer to a structure extending this structure. Annotations @NativeType:void const *

pNext

back to summary

public long pNext()

a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

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

pNext	back to summary
public VkVideoEncodeRateControlLayerInfoKHR pNext(VkVideoEncodeH264RateControlLayerInfoEXT value) Prepends the specified `VkVideoEncodeH264RateControlLayerInfoEXT` value to the `pNext` chain.

pNext	back to summary
public VkVideoEncodeRateControlLayerInfoKHR pNext(VkVideoEncodeH265RateControlLayerInfoEXT value) Prepends the specified `VkVideoEncodeH265RateControlLayerInfoEXT` value to the `pNext` chain.

set	back to summary
public VkVideoEncodeRateControlLayerInfoKHR set(int sType, long pNext, long averageBitrate, long maxBitrate, int frameRateNumerator, int frameRateDenominator) Initializes this struct with the specified values.

set

back to summary

public VkVideoEncodeRateControlLayerInfoKHR set(VkVideoEncodeRateControlLayerInfoKHR src)

Copies the specified struct data to this struct.

Parameters

src:VkVideoEncodeRateControlLayerInfoKHR: the source struct

Returns:VkVideoEncodeRateControlLayerInfoKHR

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 VkVideoEncodeRateControlLayerInfoKHR sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkVideoEncodeRateControlLayerInfoKHR sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_LAYER_INFO_KHR` value to the `sType` field.

org.lwjgl.vulkan back to summary

public Class VkVideoEncodeRateControlLayerInfoKHR.Buffer

Class Inheritance

extends StructBuffer<VkVideoEncodeRateControlLayerInfoKHR, VkVideoEncodeRateControlLayerInfoKHR.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of VkVideoEncodeRateControlLayerInfoKHR structs.

Field Summary

Modifier and Type	Field and Description
private static final VkVideoEncodeRateControlLayerInfoKHR	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkVideoEncodeRateControlLayerInfoKHR.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 long	Returns: the value of the `VkVideoEncodeRateControlLayerInfoKHR#averageBitrate` field. averageBitrate()
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	averageBitrate(long value) Sets the specified value to the `VkVideoEncodeRateControlLayerInfoKHR#averageBitrate` field.
public int	Returns: the value of the `VkVideoEncodeRateControlLayerInfoKHR#frameRateDenominator` field. frameRateDenominator()
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	frameRateDenominator(int value) Sets the specified value to the `VkVideoEncodeRateControlLayerInfoKHR#frameRateDenominator` field.
public int	Returns: the value of the `VkVideoEncodeRateControlLayerInfoKHR#frameRateNumerator` field. frameRateNumerator()
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	frameRateNumerator(int value) Sets the specified value to the `VkVideoEncodeRateControlLayerInfoKHR#frameRateNumerator` field.
protected VkVideoEncodeRateControlLayerInfoKHR	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkVideoEncodeRateControlLayerInfoKHR#maxBitrate` field. maxBitrate()
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	maxBitrate(long value) Sets the specified value to the `VkVideoEncodeRateControlLayerInfoKHR#maxBitrate` field.
public long	Returns: the value of the `VkVideoEncodeRateControlLayerInfoKHR#pNext` field. pNext()
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	pNext(long value) Sets the specified value to the `VkVideoEncodeRateControlLayerInfoKHR#pNext` field.
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	pNext(VkVideoEncodeH264RateControlLayerInfoEXT value) Prepends the specified `VkVideoEncodeH264RateControlLayerInfoEXT` value to the `pNext` chain.
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	pNext(VkVideoEncodeH265RateControlLayerInfoEXT value) Prepends the specified `VkVideoEncodeH265RateControlLayerInfoEXT` value to the `pNext` chain.
protected VkVideoEncodeRateControlLayerInfoKHR.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkVideoEncodeRateControlLayerInfoKHR#sType` field. sType()
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	sType(int value) Sets the specified value to the `VkVideoEncodeRateControlLayerInfoKHR#sType` field.
public VkVideoEncodeRateControlLayerInfoKHR.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_LAYER_INFO_KHR` value to the `VkVideoEncodeRateControlLayerInfoKHR#sType` 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 VkVideoEncodeRateControlLayerInfoKHR ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkVideoEncodeRateControlLayerInfoKHR.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 VkVideoEncodeRateControlLayerInfoKHR#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

averageBitrate	back to summary
public long averageBitrate() Returns:long the value of the `VkVideoEncodeRateControlLayerInfoKHR#averageBitrate` field. Annotations @NativeType:uint64_t

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

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

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

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

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

getElementFactory

back to summary

protected VkVideoEncodeRateControlLayerInfoKHR getElementFactory()

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

Annotations

@Override

maxBitrate	back to summary
public long maxBitrate() Returns:long the value of the `VkVideoEncodeRateControlLayerInfoKHR#maxBitrate` field. Annotations @NativeType:uint64_t

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

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

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

pNext	back to summary
public VkVideoEncodeRateControlLayerInfoKHR.Buffer pNext(VkVideoEncodeH264RateControlLayerInfoEXT value) Prepends the specified `VkVideoEncodeH264RateControlLayerInfoEXT` value to the `pNext` chain.

pNext	back to summary
public VkVideoEncodeRateControlLayerInfoKHR.Buffer pNext(VkVideoEncodeH265RateControlLayerInfoEXT value) Prepends the specified `VkVideoEncodeH265RateControlLayerInfoEXT` value to the `pNext` chain.

self

back to summary

protected VkVideoEncodeRateControlLayerInfoKHR.Buffer self()

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

Annotations

@Override

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

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

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

public Class VkVideoEncodeRateControlLayerInfoKHR

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 VkVideoEncodeRateControlLayerInfoKHR.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail