Package org.lwjgl.vulkan

Class VkVideoEncodeH264RateControlLayerInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeH264RateControlLayerInfoEXT>

org.lwjgl.vulkan.VkVideoEncodeH264RateControlLayerInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkVideoEncodeH264RateControlLayerInfoEXT
extends org.lwjgl.system.Struct<VkVideoEncodeH264RateControlLayerInfoEXT>
implements org.lwjgl.system.NativeResource

Structure describing H.264 per-layer rate control parameters.

Description

H.264-specific per-layer rate control parameters must be specified by adding a VkVideoEncodeH264RateControlLayerInfoEXT structure to the pNext chain of each VkVideoEncodeRateControlLayerInfoKHR structure in a call to CmdControlVideoCodingKHR command, when the command buffer context has an active video encode H.264 session.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_LAYER_INFO_EXT
• minQp must be a valid VkVideoEncodeH264QpEXT structure
• maxQp must be a valid VkVideoEncodeH264QpEXT structure
• maxFrameSize must be a valid VkVideoEncodeH264FrameSizeEXT structure

See Also

VkVideoEncodeH264FrameSizeEXT, VkVideoEncodeH264QpEXT

Layout

 struct VkVideoEncodeH264RateControlLayerInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkBool32 useMinQp();
     VkVideoEncodeH264QpEXT minQp();
     VkBool32 useMaxQp();
     VkVideoEncodeH264QpEXT maxQp();
     VkBool32 useMaxFrameSize();
     VkVideoEncodeH264FrameSizeEXT maxFrameSize();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeH264RateControlLayerInfoEXT.Buffer	An array of VkVideoEncodeH264RateControlLayerInfoEXT structs.

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MAXFRAMESIZE	The struct member offsets.
static final int	MAXQP	The struct member offsets.
static final int	MINQP	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	USEMAXFRAMESIZE	The struct member offsets.
static final int	USEMAXQP	The struct member offsets.
static final int	USEMINQP	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
VkVideoEncodeH264RateControlLayerInfoEXT(ByteBuffer container)	Creates a VkVideoEncodeH264RateControlLayerInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeH264RateControlLayerInfoEXT	calloc()	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance allocated with memCalloc.
static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT.Buffer instance allocated with memCalloc.
static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeH264RateControlLayerInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeH264RateControlLayerInfoEXT	create()	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance allocated with BufferUtils.
static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer	create(int capacity)	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT.Buffer instance allocated with BufferUtils.
static VkVideoEncodeH264RateControlLayerInfoEXT	create(long address)	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance for the specified memory address.
static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer	create(long address, int capacity)	Create a VkVideoEncodeH264RateControlLayerInfoEXT.Buffer instance at the specified memory.
static VkVideoEncodeH264RateControlLayerInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoEncodeH264RateControlLayerInfoEXT	malloc()	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance allocated with memAlloc.
static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT.Buffer instance allocated with memAlloc.
static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeH264RateControlLayerInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance allocated on the specified MemoryStack.
VkVideoEncodeH264FrameSizeEXT	maxFrameSize()	provides the upper bound on the encoded frame size for each picture type.
VkVideoEncodeH264RateControlLayerInfoEXT	maxFrameSize(Consumer<VkVideoEncodeH264FrameSizeEXT> consumer)	Passes the maxFrameSize() field to the specified Consumer.
VkVideoEncodeH264RateControlLayerInfoEXT	maxFrameSize(VkVideoEncodeH264FrameSizeEXT value)	Copies the specified VkVideoEncodeH264FrameSizeEXT to the maxFrameSize() field.
VkVideoEncodeH264QpEXT	maxQp()	provides the upper bound on the QP values for each picture type, to be used in rate control calculations.
VkVideoEncodeH264RateControlLayerInfoEXT	maxQp(Consumer<VkVideoEncodeH264QpEXT> consumer)	Passes the maxQp() field to the specified Consumer.
VkVideoEncodeH264RateControlLayerInfoEXT	maxQp(VkVideoEncodeH264QpEXT value)	Copies the specified VkVideoEncodeH264QpEXT to the maxQp() field.
VkVideoEncodeH264QpEXT	minQp()	provides the lower bound on the QP values for each picture type, to be used in rate control calculations.
VkVideoEncodeH264RateControlLayerInfoEXT	minQp(Consumer<VkVideoEncodeH264QpEXT> consumer)	Passes the minQp() field to the specified Consumer.
VkVideoEncodeH264RateControlLayerInfoEXT	minQp(VkVideoEncodeH264QpEXT value)	Copies the specified VkVideoEncodeH264QpEXT to the minQp() field.
static VkVideoEncodeH264FrameSizeEXT	nmaxFrameSize(long struct)	Unsafe version of maxFrameSize().
static void	nmaxFrameSize(long struct, VkVideoEncodeH264FrameSizeEXT value)	Unsafe version of maxFrameSize.
static VkVideoEncodeH264QpEXT	nmaxQp(long struct)	Unsafe version of maxQp().
static void	nmaxQp(long struct, VkVideoEncodeH264QpEXT value)	Unsafe version of maxQp.
static VkVideoEncodeH264QpEXT	nminQp(long struct)	Unsafe version of minQp().
static void	nminQp(long struct, VkVideoEncodeH264QpEXT value)	Unsafe version of minQp.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nuseMaxFrameSize(long struct)	Unsafe version of useMaxFrameSize().
static void	nuseMaxFrameSize(long struct, int value)	Unsafe version of useMaxFrameSize.
static int	nuseMaxQp(long struct)	Unsafe version of useMaxQp().
static void	nuseMaxQp(long struct, int value)	Unsafe version of useMaxQp.
static int	nuseMinQp(long struct)	Unsafe version of useMinQp().
static void	nuseMinQp(long struct, int value)	Unsafe version of useMinQp.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoEncodeH264RateControlLayerInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoEncodeH264RateControlLayerInfoEXT	set(int sType, long pNext, boolean useMinQp, VkVideoEncodeH264QpEXT minQp, boolean useMaxQp, VkVideoEncodeH264QpEXT maxQp, boolean useMaxFrameSize, VkVideoEncodeH264FrameSizeEXT maxFrameSize)	Initializes this struct with the specified values.
VkVideoEncodeH264RateControlLayerInfoEXT	set(VkVideoEncodeH264RateControlLayerInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeH264RateControlLayerInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeH264RateControlLayerInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_LAYER_INFO_EXT value to the sType() field.
boolean	useMaxFrameSize()	indicates whether the values within maxFrameSize should be used by the implementation.
VkVideoEncodeH264RateControlLayerInfoEXT	useMaxFrameSize(boolean value)	Sets the specified value to the useMaxFrameSize() field.
boolean	useMaxQp()	indicates whether the values within maxQp should be used by the implementation.
VkVideoEncodeH264RateControlLayerInfoEXT	useMaxQp(boolean value)	Sets the specified value to the useMaxQp() field.
boolean	useMinQp()	indicates whether the values within minQp should be used by the implementation.
VkVideoEncodeH264RateControlLayerInfoEXT	useMinQp(boolean value)	Sets the specified value to the useMinQp() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

USEMINQP

public static final int USEMINQP

The struct member offsets.

MINQP

public static final int MINQP

The struct member offsets.

USEMAXQP

public static final int USEMAXQP

The struct member offsets.

MAXQP

public static final int MAXQP

The struct member offsets.

USEMAXFRAMESIZE

public static final int USEMAXFRAMESIZE

The struct member offsets.

MAXFRAMESIZE

public static final int MAXFRAMESIZE

The struct member offsets.

Constructor Details

VkVideoEncodeH264RateControlLayerInfoEXT

public VkVideoEncodeH264RateControlLayerInfoEXT(ByteBuffer container)

Creates a VkVideoEncodeH264RateControlLayerInfoEXT 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkVideoEncodeH264RateControlLayerInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

useMinQp

public boolean useMinQp()

indicates whether the values within minQp should be used by the implementation. When it is set to FALSE, the implementation ignores the values in minQp and chooses suitable values.

minQp

public VkVideoEncodeH264QpEXT minQp()

provides the lower bound on the QP values for each picture type, to be used in rate control calculations.

useMaxQp

public boolean useMaxQp()

indicates whether the values within maxQp should be used by the implementation. When it is set to FALSE, the implementation ignores the values in maxQp and chooses suitable values.

maxQp

public VkVideoEncodeH264QpEXT maxQp()

provides the upper bound on the QP values for each picture type, to be used in rate control calculations.

useMaxFrameSize

public boolean useMaxFrameSize()

indicates whether the values within maxFrameSize should be used by the implementation.

maxFrameSize

public VkVideoEncodeH264FrameSizeEXT maxFrameSize()

provides the upper bound on the encoded frame size for each picture type. The implementation does not guarantee the encoded frame sizes will be within the specified limits, however these limits may be used as a guide in rate control calculations. If enabled and not set properly, the maxQp limit may prevent the implementation from respecting the maxFrameSize limit.

sType

public VkVideoEncodeH264RateControlLayerInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeH264RateControlLayerInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H264_RATE_CONTROL_LAYER_INFO_EXT value to the sType() field.

pNext

public VkVideoEncodeH264RateControlLayerInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

useMinQp

public VkVideoEncodeH264RateControlLayerInfoEXT useMinQp(boolean value)

Sets the specified value to the useMinQp() field.

minQp

public VkVideoEncodeH264RateControlLayerInfoEXT minQp(VkVideoEncodeH264QpEXT value)

Copies the specified VkVideoEncodeH264QpEXT to the minQp() field.

minQp

public VkVideoEncodeH264RateControlLayerInfoEXT minQp(Consumer<VkVideoEncodeH264QpEXT> consumer)

Passes the minQp() field to the specified Consumer.

useMaxQp

public VkVideoEncodeH264RateControlLayerInfoEXT useMaxQp(boolean value)

Sets the specified value to the useMaxQp() field.

maxQp

public VkVideoEncodeH264RateControlLayerInfoEXT maxQp(VkVideoEncodeH264QpEXT value)

Copies the specified VkVideoEncodeH264QpEXT to the maxQp() field.

maxQp

public VkVideoEncodeH264RateControlLayerInfoEXT maxQp(Consumer<VkVideoEncodeH264QpEXT> consumer)

Passes the maxQp() field to the specified Consumer.

useMaxFrameSize

public VkVideoEncodeH264RateControlLayerInfoEXT useMaxFrameSize(boolean value)

Sets the specified value to the useMaxFrameSize() field.

maxFrameSize

public VkVideoEncodeH264RateControlLayerInfoEXT maxFrameSize(VkVideoEncodeH264FrameSizeEXT value)

Copies the specified VkVideoEncodeH264FrameSizeEXT to the maxFrameSize() field.

maxFrameSize

public VkVideoEncodeH264RateControlLayerInfoEXT maxFrameSize(Consumer<VkVideoEncodeH264FrameSizeEXT> consumer)

Passes the maxFrameSize() field to the specified Consumer.

set

public VkVideoEncodeH264RateControlLayerInfoEXT set(int sType,
 long pNext,
 boolean useMinQp,
 VkVideoEncodeH264QpEXT minQp,
 boolean useMaxQp,
 VkVideoEncodeH264QpEXT maxQp,
 boolean useMaxFrameSize,
 VkVideoEncodeH264FrameSizeEXT maxFrameSize)

Initializes this struct with the specified values.

set

public VkVideoEncodeH264RateControlLayerInfoEXT set(VkVideoEncodeH264RateControlLayerInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeH264RateControlLayerInfoEXT malloc()

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

calloc

public static VkVideoEncodeH264RateControlLayerInfoEXT calloc()

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

create

public static VkVideoEncodeH264RateControlLayerInfoEXT create()

Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance allocated with BufferUtils.

create

public static VkVideoEncodeH264RateControlLayerInfoEXT create(long address)

Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkVideoEncodeH264RateControlLayerInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer create(int capacity)

Returns a new VkVideoEncodeH264RateControlLayerInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeH264RateControlLayerInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeH264RateControlLayerInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkVideoEncodeH264RateControlLayerInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkVideoEncodeH264RateControlLayerInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkVideoEncodeH264RateControlLayerInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkVideoEncodeH264RateControlLayerInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nuseMinQp

public static int nuseMinQp(long struct)

Unsafe version of useMinQp().

nminQp

public static VkVideoEncodeH264QpEXT nminQp(long struct)

Unsafe version of minQp().

nuseMaxQp

public static int nuseMaxQp(long struct)

Unsafe version of useMaxQp().

nmaxQp

public static VkVideoEncodeH264QpEXT nmaxQp(long struct)

Unsafe version of maxQp().

nuseMaxFrameSize

public static int nuseMaxFrameSize(long struct)

Unsafe version of useMaxFrameSize().

nmaxFrameSize

public static VkVideoEncodeH264FrameSizeEXT nmaxFrameSize(long struct)

Unsafe version of maxFrameSize().

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.

nuseMinQp

public static void nuseMinQp(long struct,
 int value)

Unsafe version of useMinQp.

nminQp

public static void nminQp(long struct,
 VkVideoEncodeH264QpEXT value)

Unsafe version of minQp.

nuseMaxQp

public static void nuseMaxQp(long struct,
 int value)

Unsafe version of useMaxQp.

nmaxQp

public static void nmaxQp(long struct,
 VkVideoEncodeH264QpEXT value)

Unsafe version of maxQp.

nuseMaxFrameSize

public static void nuseMaxFrameSize(long struct,
 int value)

Unsafe version of useMaxFrameSize.

nmaxFrameSize

public static void nmaxFrameSize(long struct,
 VkVideoEncodeH264FrameSizeEXT value)

Unsafe version of maxFrameSize.