java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkVideoEncodeRateControlInfoKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkVideoEncodeRateControlInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure to set encode stream rate control parameters.
Description

In order to provide video encode stream rate control settings, add a VkVideoEncodeRateControlInfoKHR structure to the pNext chain of the VkVideoCodingControlInfoKHR structure passed to the CmdControlVideoCodingKHR command.

A codec-specific extension structure for further encode stream rate control parameter settings may be chained to VkVideoEncodeRateControlInfoKHR.

To ensure that the video session is properly initalized 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
- VkVideoEncodeH264RateControlInfoEXT must be included in the pNext chain of VkVideoEncodeRateControlInfoKHR if and only if VkVideoEncodeRateControlInfoKHR::rateControlMode is not VIDEO_ENCODE_RATE_CONTROL_MODE_NONE_BIT_KHR and the bound video session was created with VkVideoProfileKHR::videoCodecOperation set to VIDEO_CODEC_OPERATION_ENCODE_H264_BIT_EXT.
- If VkVideoEncodeRateControlInfoKHR::layerCount is greater than 1, then VkVideoEncodeH264RateControlInfoEXT::temporalLayerCount must be equal to layerCount.
- VkVideoEncodeH265RateControlInfoEXT must be included in the pNext chain of VkVideoEncodeRateControlInfoKHR if and only if VkVideoEncodeRateControlInfoKHR::rateControlMode is not VIDEO_ENCODE_RATE_CONTROL_MODE_NONE_BIT_KHR and the bound video session was created with VkVideoProfileKHR::videoCodecOperation set to VIDEO_CODEC_OPERATION_ENCODE_H265_BIT_EXT.
- If VkVideoEncodeRateControlInfoKHR::layerCount is greater than 1, then VkVideoEncodeH265RateControlInfoEXT::subLayerCount must be equal to layerCount.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_INFO_KHR
- rateControlMode must be a valid VkVideoEncodeRateControlModeFlagBitsKHR value
- pLayerConfigs must be a valid pointer to an array of layerCount valid VkVideoEncodeRateControlLayerInfoKHR structures
- layerCount must be greater than 0
See Also

VkVideoEncodeRateControlLayerInfoKHR

Layout
```
 struct VkVideoEncodeRateControlInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkVideoEncodeRateControlFlagsKHR flags();
     VkVideoEncodeRateControlModeFlagBitsKHR rateControlMode();
     uint8_t layerCount();
     VkVideoEncodeRateControlLayerInfoKHR const * pLayerConfigs();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkVideoEncodeRateControlInfoKHR.Buffer
An array of VkVideoEncodeRateControlInfoKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`FLAGS LAYERCOUNT PLAYERCONFIGS PNEXT RATECONTROLMODE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static 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
`VkVideoEncodeRateControlInfoKHR(java.nio.ByteBuffer container)`	Creates a `VkVideoEncodeRateControlInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkVideoEncodeRateControlInfoKHR`	`calloc(org.lwjgl.system.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 VkVideoEncodeRateControlInfoKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkVideoEncodeRateControlInfoKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()`	a bitmask of `VkVideoEncodeRateControlFlagBitsKHR` specifying encode rate control flags.
`VkVideoEncodeRateControlInfoKHR`	`flags(int value)`	Sets the specified value to the `flags()` field.
`byte`	`layerCount()`	specifies the number of rate control layers in the video encode stream.
`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, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoEncodeRateControlInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkVideoEncodeRateControlInfoKHR`	`malloc(org.lwjgl.system.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 byte`	`nlayerCount(long struct)`	Unsafe version of `layerCount()`.
`static void`	`nlayerCount(long struct, byte value)`	Sets the specified value to the `layerCount` field of the specified `struct`.
`static VkVideoEncodeRateControlLayerInfoKHR.Buffer`	`npLayerConfigs(long struct)`	Unsafe version of `pLayerConfigs()`.
`static void`	`npLayerConfigs(long struct, VkVideoEncodeRateControlLayerInfoKHR.Buffer value)`	Unsafe version of `pLayerConfigs`.
`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`.
`VkVideoEncodeRateControlLayerInfoKHR.Buffer`	`pLayerConfigs()`	a pointer to an array of `VkVideoEncodeRateControlLayerInfoKHR` structures specifying the rate control configurations of `layerCount` rate control layers.
`VkVideoEncodeRateControlInfoKHR`	`pLayerConfigs(VkVideoEncodeRateControlLayerInfoKHR.Buffer value)`	Sets the address of the specified `VkVideoEncodeRateControlLayerInfoKHR.Buffer` to the `pLayerConfigs()` field.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkVideoEncodeRateControlInfoKHR`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkVideoEncodeRateControlInfoKHR`	`pNext(VkVideoEncodeH264RateControlInfoEXT value)`	Prepends the specified `VkVideoEncodeH264RateControlInfoEXT` value to the `pNext` chain.
`VkVideoEncodeRateControlInfoKHR`	`pNext(VkVideoEncodeH265RateControlInfoEXT value)`	Prepends the specified `VkVideoEncodeH265RateControlInfoEXT` value to the `pNext` chain.
`int`	`rateControlMode()`	a `VkVideoEncodeRateControlModeFlagBitsKHR` value specifying the encode stream rate control mode.
`VkVideoEncodeRateControlInfoKHR`	`rateControlMode(int value)`	Sets the specified value to the `rateControlMode()` field.
`VkVideoEncodeRateControlInfoKHR`	`set(int sType, long pNext, int flags, int rateControlMode, VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayerConfigs)`	Initializes this struct with the specified values.
`VkVideoEncodeRateControlInfoKHR`	`set(VkVideoEncodeRateControlInfoKHR src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`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`.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, FLAGS, RATECONTROLMODE, LAYERCOUNT, PLAYERCONFIGS
    
    The struct member offsets.
- Constructor Detail
  - VkVideoEncodeRateControlInfoKHR
```
public VkVideoEncodeRateControlInfoKHR(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    the type of this structure.
  - pNext
```
public long pNext()
```
    NULL or a pointer to a structure extending this structure.
  - flags
```
public int flags()
```
    a bitmask of VkVideoEncodeRateControlFlagBitsKHR specifying encode rate control flags.
  - rateControlMode
```
public int rateControlMode()
```
    a VkVideoEncodeRateControlModeFlagBitsKHR value specifying the encode stream rate control mode.
  - layerCount
```
public byte layerCount()
```
    specifies the number of rate control layers in the video encode stream.
  - pLayerConfigs
```
public VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayerConfigs()
```
    a pointer to an array of VkVideoEncodeRateControlLayerInfoKHR structures specifying the rate control configurations of layerCount rate control layers.
  - sType
```
public VkVideoEncodeRateControlInfoKHR sType(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(long value)
```
    Sets the specified value to the pNext() field.
  - pNext
```
public VkVideoEncodeRateControlInfoKHR pNext(VkVideoEncodeH264RateControlInfoEXT value)
```
    Prepends the specified VkVideoEncodeH264RateControlInfoEXT value to the pNext chain.
  - pNext
```
public VkVideoEncodeRateControlInfoKHR pNext(VkVideoEncodeH265RateControlInfoEXT value)
```
    Prepends the specified VkVideoEncodeH265RateControlInfoEXT value to the pNext chain.
  - flags
```
public VkVideoEncodeRateControlInfoKHR flags(int value)
```
    Sets the specified value to the flags() field.
  - rateControlMode
```
public VkVideoEncodeRateControlInfoKHR rateControlMode(int value)
```
    Sets the specified value to the rateControlMode() field.
  - pLayerConfigs
```
public VkVideoEncodeRateControlInfoKHR pLayerConfigs(VkVideoEncodeRateControlLayerInfoKHR.Buffer value)
```
    Sets the address of the specified VkVideoEncodeRateControlLayerInfoKHR.Buffer to the pLayerConfigs() field.
  - set
```
public VkVideoEncodeRateControlInfoKHR set(int sType,
                                           long pNext,
                                           int flags,
                                           int rateControlMode,
                                           VkVideoEncodeRateControlLayerInfoKHR.Buffer pLayerConfigs)
```
    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
```
@Nullable
public static 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
```
@Nullable
public static VkVideoEncodeRateControlInfoKHR.Buffer createSafe(long address,
                                                                int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkVideoEncodeRateControlInfoKHR malloc(org.lwjgl.system.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(org.lwjgl.system.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,
                                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoEncodeRateControlInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkVideoEncodeRateControlInfoKHR.Buffer calloc(int capacity,
                                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoEncodeRateControlInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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 byte nlayerCount(long struct)
```
    Unsafe version of layerCount().
  - npLayerConfigs
```
public static VkVideoEncodeRateControlLayerInfoKHR.Buffer npLayerConfigs(long struct)
```
    Unsafe version of pLayerConfigs().
  - 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,
                               byte value)
```
    Sets the specified value to the layerCount field of the specified struct.
  - npLayerConfigs
```
public static void npLayerConfigs(long struct,
                                  VkVideoEncodeRateControlLayerInfoKHR.Buffer value)
```
    Unsafe version of pLayerConfigs.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate

Class VkVideoEncodeRateControlInfoKHR

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, FLAGS, RATECONTROLMODE, LAYERCOUNT, PLAYERCONFIGS

Constructor Detail

VkVideoEncodeRateControlInfoKHR

Method Detail

sizeof

sType

pNext

flags

rateControlMode

layerCount

pLayerConfigs

sType

sType$Default

pNext

pNext

pNext

flags

rateControlMode

pLayerConfigs

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nflags

nrateControlMode

nlayerCount

npLayerConfigs

nsType

npNext

nflags

nrateControlMode

nlayerCount

npLayerConfigs

validate