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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkVideoEncodeH264RateControlInfoEXT
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing H.264 stream rate control parameters.
Description

In order to provide H.264-specific stream rate control parameters, add a VkVideoEncodeH264RateControlInfoEXT structure to the pNext chain of the VkVideoEncodeRateControlInfoKHR structure in the pNext chain of the VkVideoCodingControlInfoKHR structure passed to the CmdControlVideoCodingKHR command.

The parameters from this structure act as a guidance for implementations to apply various rate control heuristics.

It is possible to infer the picture type to be used when encoding a frame, on the basis of the values provided for consecutiveBFrameCount, idrPeriod, and gopFrameCount, but this inferred picture type will not be used by implementations to override the picture type provided in CmdEncodeVideoKHR. Additionally, it is not required for the video session to be reset if the inferred picture type does not match the actual picture type.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_INFO_EXT
- rateControlStructure must be a valid VkVideoEncodeH264RateControlStructureFlagBitsEXT value
Layout
```
 struct VkVideoEncodeH264RateControlInfoEXT {
     VkStructureType sType();
     void const * pNext();
     uint32_t gopFrameCount();
     uint32_t idrPeriod();
     uint32_t consecutiveBFrameCount();
     VkVideoEncodeH264RateControlStructureFlagBitsEXT rateControlStructure();
     uint8_t temporalLayerCount();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkVideoEncodeH264RateControlInfoEXT.Buffer
An array of VkVideoEncodeH264RateControlInfoEXT 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`	`CONSECUTIVEBFRAMECOUNT GOPFRAMECOUNT IDRPERIOD PNEXT RATECONTROLSTRUCTURE`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE TEMPORALLAYERCOUNT`	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
`VkVideoEncodeH264RateControlInfoEXT(java.nio.ByteBuffer container)`	Creates a `VkVideoEncodeH264RateControlInfoEXT` 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 VkVideoEncodeH264RateControlInfoEXT`	`calloc()`	Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated with `memCalloc`.
`static VkVideoEncodeH264RateControlInfoEXT.Buffer`	`calloc(int capacity)`	Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated with `memCalloc`.
`static VkVideoEncodeH264RateControlInfoEXT.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkVideoEncodeH264RateControlInfoEXT`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`consecutiveBFrameCount()`	the number of consecutive B-frames between I- and/or P-frames within the GOP.
`VkVideoEncodeH264RateControlInfoEXT`	`consecutiveBFrameCount(int value)`	Sets the specified value to the `consecutiveBFrameCount()` field.
`static VkVideoEncodeH264RateControlInfoEXT`	`create()`	Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated with `BufferUtils`.
`static VkVideoEncodeH264RateControlInfoEXT.Buffer`	`create(int capacity)`	Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated with `BufferUtils`.
`static VkVideoEncodeH264RateControlInfoEXT`	`create(long address)`	Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance for the specified memory address.
`static VkVideoEncodeH264RateControlInfoEXT.Buffer`	`create(long address, int capacity)`	Create a `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance at the specified memory.
`static VkVideoEncodeH264RateControlInfoEXT`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkVideoEncodeH264RateControlInfoEXT.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`int`	`gopFrameCount()`	the number of frames contained within the group of pictures (GOP), starting from an intra frame and until the next intra frame.
`VkVideoEncodeH264RateControlInfoEXT`	`gopFrameCount(int value)`	Sets the specified value to the `gopFrameCount()` field.
`int`	`idrPeriod()`	the interval, in terms of number of frames, between two IDR frames.
`VkVideoEncodeH264RateControlInfoEXT`	`idrPeriod(int value)`	Sets the specified value to the `idrPeriod()` field.
`static VkVideoEncodeH264RateControlInfoEXT`	`malloc()`	Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated with `memAlloc`.
`static VkVideoEncodeH264RateControlInfoEXT.Buffer`	`malloc(int capacity)`	Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated with `memAlloc`.
`static VkVideoEncodeH264RateControlInfoEXT.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkVideoEncodeH264RateControlInfoEXT`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated on the specified `MemoryStack`.
`static int`	`nconsecutiveBFrameCount(long struct)`	Unsafe version of `consecutiveBFrameCount()`.
`static void`	`nconsecutiveBFrameCount(long struct, int value)`	Unsafe version of `consecutiveBFrameCount`.
`static int`	`ngopFrameCount(long struct)`	Unsafe version of `gopFrameCount()`.
`static void`	`ngopFrameCount(long struct, int value)`	Unsafe version of `gopFrameCount`.
`static int`	`nidrPeriod(long struct)`	Unsafe version of `idrPeriod()`.
`static void`	`nidrPeriod(long struct, int value)`	Unsafe version of `idrPeriod`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nrateControlStructure(long struct)`	Unsafe version of `rateControlStructure()`.
`static void`	`nrateControlStructure(long struct, int value)`	Unsafe version of `rateControlStructure`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`static byte`	`ntemporalLayerCount(long struct)`	Unsafe version of `temporalLayerCount()`.
`static void`	`ntemporalLayerCount(long struct, byte value)`	Unsafe version of `temporalLayerCount`.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkVideoEncodeH264RateControlInfoEXT`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`int`	`rateControlStructure()`	a `VkVideoEncodeH264RateControlStructureFlagBitsEXT` value specifying the expected encode stream reference structure, to aid in rate control calculations.
`VkVideoEncodeH264RateControlInfoEXT`	`rateControlStructure(int value)`	Sets the specified value to the `rateControlStructure()` field.
`VkVideoEncodeH264RateControlInfoEXT`	`set(int sType, long pNext, int gopFrameCount, int idrPeriod, int consecutiveBFrameCount, int rateControlStructure, byte temporalLayerCount)`	Initializes this struct with the specified values.
`VkVideoEncodeH264RateControlInfoEXT`	`set(VkVideoEncodeH264RateControlInfoEXT src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkVideoEncodeH264RateControlInfoEXT`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkVideoEncodeH264RateControlInfoEXT`	`sType$Default()`	Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_INFO_EXT` value to the `sType()` field.
`byte`	`temporalLayerCount()`	specifies the number of temporal layers enabled in the stream.
`VkVideoEncodeH264RateControlInfoEXT`	`temporalLayerCount(byte value)`	Sets the specified value to the `temporalLayerCount()` field.

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, GOPFRAMECOUNT, IDRPERIOD, CONSECUTIVEBFRAMECOUNT, RATECONTROLSTRUCTURE, TEMPORALLAYERCOUNT
    
    The struct member offsets.
- Constructor Detail
  - VkVideoEncodeH264RateControlInfoEXT
```
public VkVideoEncodeH264RateControlInfoEXT(java.nio.ByteBuffer container)
```
    Creates a VkVideoEncodeH264RateControlInfoEXT 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.
  - gopFrameCount
```
public int gopFrameCount()
```
    the number of frames contained within the group of pictures (GOP), starting from an intra frame and until the next intra frame. If it is set to 0, the implementation chooses a suitable value. If it is set to UINT32_MAX, the GOP length is treated as infinite.
  - idrPeriod
```
public int idrPeriod()
```
    the interval, in terms of number of frames, between two IDR frames. If it is set to 0, the implementation chooses a suitable value. If it is set to UINT32_MAX, the IDR period is treated as infinite.
  - consecutiveBFrameCount
```
public int consecutiveBFrameCount()
```
    the number of consecutive B-frames between I- and/or P-frames within the GOP.
  - rateControlStructure
```
public int rateControlStructure()
```
    a VkVideoEncodeH264RateControlStructureFlagBitsEXT value specifying the expected encode stream reference structure, to aid in rate control calculations.
  - temporalLayerCount
```
public byte temporalLayerCount()
```
    specifies the number of temporal layers enabled in the stream.
  - sType
```
public VkVideoEncodeH264RateControlInfoEXT sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkVideoEncodeH264RateControlInfoEXT sType$Default()
```
    Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_INFO_EXT value to the sType() field.
  - pNext
```
public VkVideoEncodeH264RateControlInfoEXT pNext(long value)
```
    Sets the specified value to the pNext() field.
  - gopFrameCount
```
public VkVideoEncodeH264RateControlInfoEXT gopFrameCount(int value)
```
    Sets the specified value to the gopFrameCount() field.
  - idrPeriod
```
public VkVideoEncodeH264RateControlInfoEXT idrPeriod(int value)
```
    Sets the specified value to the idrPeriod() field.
  - consecutiveBFrameCount
```
public VkVideoEncodeH264RateControlInfoEXT consecutiveBFrameCount(int value)
```
    Sets the specified value to the consecutiveBFrameCount() field.
  - rateControlStructure
```
public VkVideoEncodeH264RateControlInfoEXT rateControlStructure(int value)
```
    Sets the specified value to the rateControlStructure() field.
  - temporalLayerCount
```
public VkVideoEncodeH264RateControlInfoEXT temporalLayerCount(byte value)
```
    Sets the specified value to the temporalLayerCount() field.
  - set
```
public VkVideoEncodeH264RateControlInfoEXT set(int sType,
                                               long pNext,
                                               int gopFrameCount,
                                               int idrPeriod,
                                               int consecutiveBFrameCount,
                                               int rateControlStructure,
                                               byte temporalLayerCount)
```
    Initializes this struct with the specified values.
  - set
```
public VkVideoEncodeH264RateControlInfoEXT set(VkVideoEncodeH264RateControlInfoEXT src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkVideoEncodeH264RateControlInfoEXT malloc()
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkVideoEncodeH264RateControlInfoEXT calloc()
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkVideoEncodeH264RateControlInfoEXT create()
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT instance allocated with BufferUtils.
  - create
```
public static VkVideoEncodeH264RateControlInfoEXT create(long address)
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkVideoEncodeH264RateControlInfoEXT createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkVideoEncodeH264RateControlInfoEXT.Buffer malloc(int capacity)
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkVideoEncodeH264RateControlInfoEXT.Buffer calloc(int capacity)
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkVideoEncodeH264RateControlInfoEXT.Buffer create(int capacity)
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkVideoEncodeH264RateControlInfoEXT.Buffer create(long address,
                                                                int capacity)
```
    Create a VkVideoEncodeH264RateControlInfoEXT.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkVideoEncodeH264RateControlInfoEXT.Buffer createSafe(long address,
                                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkVideoEncodeH264RateControlInfoEXT malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkVideoEncodeH264RateControlInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - malloc
```
public static VkVideoEncodeH264RateControlInfoEXT.Buffer malloc(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkVideoEncodeH264RateControlInfoEXT.Buffer calloc(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkVideoEncodeH264RateControlInfoEXT.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().
  - ngopFrameCount
```
public static int ngopFrameCount(long struct)
```
    Unsafe version of gopFrameCount().
  - nidrPeriod
```
public static int nidrPeriod(long struct)
```
    Unsafe version of idrPeriod().
  - nconsecutiveBFrameCount
```
public static int nconsecutiveBFrameCount(long struct)
```
    Unsafe version of consecutiveBFrameCount().
  - nrateControlStructure
```
public static int nrateControlStructure(long struct)
```
    Unsafe version of rateControlStructure().
  - ntemporalLayerCount
```
public static byte ntemporalLayerCount(long struct)
```
    Unsafe version of temporalLayerCount().
  - 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.
  - ngopFrameCount
```
public static void ngopFrameCount(long struct,
                                  int value)
```
    Unsafe version of gopFrameCount.
  - nidrPeriod
```
public static void nidrPeriod(long struct,
                              int value)
```
    Unsafe version of idrPeriod.
  - nconsecutiveBFrameCount
```
public static void nconsecutiveBFrameCount(long struct,
                                           int value)
```
    Unsafe version of consecutiveBFrameCount.
  - nrateControlStructure
```
public static void nrateControlStructure(long struct,
                                         int value)
```
    Unsafe version of rateControlStructure.
  - ntemporalLayerCount
```
public static void ntemporalLayerCount(long struct,
                                       byte value)
```
    Unsafe version of temporalLayerCount.

Class VkVideoEncodeH264RateControlInfoEXT

Description

Valid Usage (Implicit)

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, GOPFRAMECOUNT, IDRPERIOD, CONSECUTIVEBFRAMECOUNT, RATECONTROLSTRUCTURE, TEMPORALLAYERCOUNT

Constructor Detail

VkVideoEncodeH264RateControlInfoEXT

Method Detail

sizeof

sType

pNext

gopFrameCount

idrPeriod

consecutiveBFrameCount

rateControlStructure

temporalLayerCount

sType

sType$Default

pNext

gopFrameCount

idrPeriod

consecutiveBFrameCount

rateControlStructure

temporalLayerCount

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

ngopFrameCount

nidrPeriod

nconsecutiveBFrameCount

nrateControlStructure

ntemporalLayerCount

nsType

npNext

ngopFrameCount

nidrPeriod

nconsecutiveBFrameCount

nrateControlStructure

ntemporalLayerCount