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
flags must be a valid combination of VkVideoEncodeH264RateControlFlagBitsEXT values

Layout


struct VkVideoEncodeH264RateControlInfoEXT {
    VkStructureType sType;
    void const * pNext;
    VkVideoEncodeH264RateControlFlagsEXT flags;
    uint32_t gopFrameCount;
    uint32_t idrPeriod;
    uint32_t consecutiveBFrameCount;
    uint32_t temporalLayerCount;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	CONSECUTIVEBFRAMECOUNT The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	GOPFRAMECOUNT The struct member offsets.
public static final int	IDRPERIOD 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.
public static final int	TEMPORALLAYERCOUNT The struct member offsets.

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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public static VkVideoEncodeH264RateControlInfoEXT	calloc() Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated with `memCalloc`.
public static VkVideoEncodeH264RateControlInfoEXT.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated with `memCalloc`.
public static VkVideoEncodeH264RateControlInfoEXT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkVideoEncodeH264RateControlInfoEXT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public int	consecutiveBFrameCount() the number of consecutive B-frames between I- and/or P-frames within the GOP.
public VkVideoEncodeH264RateControlInfoEXT	consecutiveBFrameCount(int value) Sets the specified value to the `consecutiveBFrameCount` field.
protected VkVideoEncodeH264RateControlInfoEXT	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 VkVideoEncodeH264RateControlInfoEXT	create() Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated with `BufferUtils`.
public static VkVideoEncodeH264RateControlInfoEXT	create(long address) Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance for the specified memory address.
public static VkVideoEncodeH264RateControlInfoEXT.Buffer	create(int the buffer capacity capacity) Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated with `BufferUtils`.
public static VkVideoEncodeH264RateControlInfoEXT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance at the specified memory.
public static VkVideoEncodeH264RateControlInfoEXT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkVideoEncodeH264RateControlInfoEXT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() a bitmask of `VkVideoEncodeH264RateControlFlagBitsEXT` specifying H.264 rate control flags.
public VkVideoEncodeH264RateControlInfoEXT	flags(int value) Sets the specified value to the `flags` field.
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.
public VkVideoEncodeH264RateControlInfoEXT	gopFrameCount(int value) Sets the specified value to the `gopFrameCount` field.
public int	idrPeriod() the interval, in terms of number of frames, between two IDR frames.
public VkVideoEncodeH264RateControlInfoEXT	idrPeriod(int value) Sets the specified value to the `idrPeriod` field.
public static VkVideoEncodeH264RateControlInfoEXT	malloc() Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated with `memAlloc`.
public static VkVideoEncodeH264RateControlInfoEXT.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated with `memAlloc`.
public static VkVideoEncodeH264RateControlInfoEXT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated on the specified `MemoryStack`.
public static VkVideoEncodeH264RateControlInfoEXT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkVideoEncodeH264RateControlInfoEXT.Buffer` instance allocated on the specified `MemoryStack`.
public static int	nconsecutiveBFrameCount(long struct) Unsafe version of `consecutiveBFrameCount`.
public static void	nconsecutiveBFrameCount(long struct, int value) Unsafe version of `consecutiveBFrameCount`.
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	ngopFrameCount(long struct) Unsafe version of `gopFrameCount`.
public static void	ngopFrameCount(long struct, int value) Unsafe version of `gopFrameCount`.
public static int	nidrPeriod(long struct) Unsafe version of `idrPeriod`.
public static void	nidrPeriod(long struct, int value) Unsafe version of `idrPeriod`.
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 static int	ntemporalLayerCount(long struct) Unsafe version of `temporalLayerCount`.
public static void	ntemporalLayerCount(long struct, int value) Unsafe version of `temporalLayerCount`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkVideoEncodeH264RateControlInfoEXT	pNext(long value) Sets the specified value to the `pNext` field.
public VkVideoEncodeH264RateControlInfoEXT	set(int sType, long pNext, int flags, int gopFrameCount, int idrPeriod, int consecutiveBFrameCount, int temporalLayerCount) Initializes this struct with the specified values.
public VkVideoEncodeH264RateControlInfoEXT	Returns: this struct set(VkVideoEncodeH264RateControlInfoEXT 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 VkVideoEncodeH264RateControlInfoEXT	sType(int value) Sets the specified value to the `sType` field.
public VkVideoEncodeH264RateControlInfoEXT	sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_INFO_EXT` value to the `sType` field.
public int	temporalLayerCount() specifies the number of temporal layers enabled in the stream.
public VkVideoEncodeH264RateControlInfoEXT	temporalLayerCount(int value) Sets the specified value to the `temporalLayerCount` field.

Field Detail

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

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

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

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

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

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

Constructor Detail

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

VkVideoEncodeH264RateControlInfoEXT back to summary

VkVideoEncodeH264RateControlInfoEXT	back to summary
public VkVideoEncodeH264RateControlInfoEXT(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.

public VkVideoEncodeH264RateControlInfoEXT(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

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

calloc back to summary

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

public static VkVideoEncodeH264RateControlInfoEXT.Buffer calloc(int capacity)

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

public static VkVideoEncodeH264RateControlInfoEXT calloc(MemoryStack stack)

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

Returns a new VkVideoEncodeH264RateControlInfoEXT.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

consecutiveBFrameCount	back to summary
public int consecutiveBFrameCount() the number of consecutive B-frames between I- and/or P-frames within the GOP. Annotations @NativeType:uint32_t

consecutiveBFrameCount

back to summary

public int consecutiveBFrameCount()

the number of consecutive B-frames between I- and/or P-frames within the GOP.

Annotations

@NativeType:uint32_t

consecutiveBFrameCount	back to summary
public VkVideoEncodeH264RateControlInfoEXT consecutiveBFrameCount(int value) Sets the specified value to the `consecutiveBFrameCount` field.

create back to summary

create	back to summary
protected VkVideoEncodeH264RateControlInfoEXT 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 VkVideoEncodeH264RateControlInfoEXT 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 VkVideoEncodeH264RateControlInfoEXT create() Returns a new `VkVideoEncodeH264RateControlInfoEXT` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkVideoEncodeH264RateControlInfoEXT.Buffer create(int capacity)

Returns a new VkVideoEncodeH264RateControlInfoEXT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

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

public static VkVideoEncodeH264RateControlInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

flags back to summary

flags	back to summary
public int flags() a bitmask of `VkVideoEncodeH264RateControlFlagBitsEXT` specifying H.264 rate control flags. Annotations @NativeType:VkVideoEncodeH264RateControlFlagsEXT

public int flags()

a bitmask of VkVideoEncodeH264RateControlFlagBitsEXT specifying H.264 rate control flags.

Annotations

@NativeType:VkVideoEncodeH264RateControlFlagsEXT

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

gopFrameCount back to summary

gopFrameCount	back to summary
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. Annotations @NativeType:uint32_t

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.

Annotations

@NativeType:uint32_t

gopFrameCount	back to summary
public VkVideoEncodeH264RateControlInfoEXT gopFrameCount(int value) Sets the specified value to the `gopFrameCount` field.

idrPeriod back to summary

idrPeriod	back to summary
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. Annotations @NativeType:uint32_t

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.

Annotations

@NativeType:uint32_t

idrPeriod	back to summary
public VkVideoEncodeH264RateControlInfoEXT idrPeriod(int value) Sets the specified value to the `idrPeriod` field.

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

malloc back to summary

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

public static VkVideoEncodeH264RateControlInfoEXT.Buffer malloc(int capacity)

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

public static VkVideoEncodeH264RateControlInfoEXT malloc(MemoryStack stack)

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

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

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

Parameters

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

nconsecutiveBFrameCount	back to summary
public static int nconsecutiveBFrameCount(long struct) Unsafe version of `consecutiveBFrameCount`.

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

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

ngopFrameCount	back to summary
public static int ngopFrameCount(long struct) Unsafe version of `gopFrameCount`.

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

nidrPeriod	back to summary
public static int nidrPeriod(long struct) Unsafe version of `idrPeriod`.

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

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

ntemporalLayerCount	back to summary
public static int ntemporalLayerCount(long struct) Unsafe version of `temporalLayerCount`.

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

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 VkVideoEncodeH264RateControlInfoEXT pNext(long value) Sets the specified value to the `pNext` field.

set	back to summary
public VkVideoEncodeH264RateControlInfoEXT set(int sType, long pNext, int flags, int gopFrameCount, int idrPeriod, int consecutiveBFrameCount, int temporalLayerCount) Initializes this struct with the specified values.

set

back to summary

public VkVideoEncodeH264RateControlInfoEXT set(VkVideoEncodeH264RateControlInfoEXT src)

Copies the specified struct data to this struct.

Parameters

src:VkVideoEncodeH264RateControlInfoEXT: the source struct

Returns:VkVideoEncodeH264RateControlInfoEXT

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

sType$Default	back to summary
public VkVideoEncodeH264RateControlInfoEXT sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_INFO_EXT` value to the `sType` field.

temporalLayerCount

back to summary

public int temporalLayerCount()

specifies the number of temporal layers enabled in the stream.

Annotations

@NativeType:uint32_t

temporalLayerCount	back to summary
public VkVideoEncodeH264RateControlInfoEXT temporalLayerCount(int value) Sets the specified value to the `temporalLayerCount` field.

org.lwjgl.vulkan back to summary

public Class VkVideoEncodeH264RateControlInfoEXT.Buffer

Class Inheritance

extends StructBuffer<VkVideoEncodeH264RateControlInfoEXT, VkVideoEncodeH264RateControlInfoEXT.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of VkVideoEncodeH264RateControlInfoEXT structs.

Field Summary

Modifier and Type	Field and Description
private static final VkVideoEncodeH264RateControlInfoEXT	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkVideoEncodeH264RateControlInfoEXT.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 `VkVideoEncodeH264RateControlInfoEXT#consecutiveBFrameCount` field. consecutiveBFrameCount()
public VkVideoEncodeH264RateControlInfoEXT.Buffer	consecutiveBFrameCount(int value) Sets the specified value to the `VkVideoEncodeH264RateControlInfoEXT#consecutiveBFrameCount` field.
public int	Returns: the value of the `VkVideoEncodeH264RateControlInfoEXT#flags` field. flags()
public VkVideoEncodeH264RateControlInfoEXT.Buffer	flags(int value) Sets the specified value to the `VkVideoEncodeH264RateControlInfoEXT#flags` field.
protected VkVideoEncodeH264RateControlInfoEXT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VkVideoEncodeH264RateControlInfoEXT#gopFrameCount` field. gopFrameCount()
public VkVideoEncodeH264RateControlInfoEXT.Buffer	gopFrameCount(int value) Sets the specified value to the `VkVideoEncodeH264RateControlInfoEXT#gopFrameCount` field.
public int	Returns: the value of the `VkVideoEncodeH264RateControlInfoEXT#idrPeriod` field. idrPeriod()
public VkVideoEncodeH264RateControlInfoEXT.Buffer	idrPeriod(int value) Sets the specified value to the `VkVideoEncodeH264RateControlInfoEXT#idrPeriod` field.
public long	Returns: the value of the `VkVideoEncodeH264RateControlInfoEXT#pNext` field. pNext()
public VkVideoEncodeH264RateControlInfoEXT.Buffer	pNext(long value) Sets the specified value to the `VkVideoEncodeH264RateControlInfoEXT#pNext` field.
protected VkVideoEncodeH264RateControlInfoEXT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkVideoEncodeH264RateControlInfoEXT#sType` field. sType()
public VkVideoEncodeH264RateControlInfoEXT.Buffer	sType(int value) Sets the specified value to the `VkVideoEncodeH264RateControlInfoEXT#sType` field.
public VkVideoEncodeH264RateControlInfoEXT.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_INFO_EXT` value to the `VkVideoEncodeH264RateControlInfoEXT#sType` field.
public int	Returns: the value of the `VkVideoEncodeH264RateControlInfoEXT#temporalLayerCount` field. temporalLayerCount()
public VkVideoEncodeH264RateControlInfoEXT.Buffer	temporalLayerCount(int value) Sets the specified value to the `VkVideoEncodeH264RateControlInfoEXT#temporalLayerCount` 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 VkVideoEncodeH264RateControlInfoEXT ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

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

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

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

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

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

getElementFactory

back to summary

protected VkVideoEncodeH264RateControlInfoEXT getElementFactory()

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

Annotations

@Override

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

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

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

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

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

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

self

back to summary

protected VkVideoEncodeH264RateControlInfoEXT.Buffer self()

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

Annotations

@Override

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

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

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

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

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