Package org.lwjgl.vulkan

Class VkVideoEncodeH264SessionParametersGetInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeH264SessionParametersGetInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeH264SessionParametersGetInfoKHR

All Implemented Interfaces:

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

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

Structure specifying parameters for retrieving encoded H.264 parameter set data.

Description

When this structure is specified in the pNext chain of the VkVideoEncodeSessionParametersGetInfoKHR structure passed to GetEncodedVideoSessionParametersKHR, the command will write encoded parameter data to the output buffer in the following order:

• The H.264 sequence parameter set identified by stdSPSId, if writeStdSPS is TRUE.
• The H.264 picture parameter set identified by the pair constructed from stdSPSId and stdPPSId, if writeStdPPS is TRUE.

Valid Usage

• At least one of writeStdSPS and writeStdPPS must be TRUE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_PARAMETERS_GET_INFO_KHR

Layout

 struct VkVideoEncodeH264SessionParametersGetInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkBool32 writeStdSPS();
     VkBool32 writeStdPPS();
     uint32_t stdSPSId();
     uint32_t stdPPSId();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer	An array of VkVideoEncodeH264SessionParametersGetInfoKHR 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	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STDPPSID	The struct member offsets.
static final int	STDSPSID	The struct member offsets.
static final int	STYPE	The struct member offsets.
static final int	WRITESTDPPS	The struct member offsets.
static final int	WRITESTDSPS	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
VkVideoEncodeH264SessionParametersGetInfoKHR(ByteBuffer container)	Creates a VkVideoEncodeH264SessionParametersGetInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeH264SessionParametersGetInfoKHR	calloc()	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR instance allocated with memCalloc.
static VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeH264SessionParametersGetInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeH264SessionParametersGetInfoKHR	create()	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeH264SessionParametersGetInfoKHR	create(long address)	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR instance for the specified memory address.
static VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeH264SessionParametersGetInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoEncodeH264SessionParametersGetInfoKHR	malloc()	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR instance allocated with memAlloc.
static VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeH264SessionParametersGetInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nstdPPSId(long struct)	Unsafe version of stdPPSId().
static void	nstdPPSId(long struct, int value)	Unsafe version of stdPPSId.
static int	nstdSPSId(long struct)	Unsafe version of stdSPSId().
static void	nstdSPSId(long struct, int value)	Unsafe version of stdSPSId.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nwriteStdPPS(long struct)	Unsafe version of writeStdPPS().
static void	nwriteStdPPS(long struct, int value)	Unsafe version of writeStdPPS.
static int	nwriteStdSPS(long struct)	Unsafe version of writeStdSPS().
static void	nwriteStdSPS(long struct, int value)	Unsafe version of writeStdSPS.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoEncodeH264SessionParametersGetInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoEncodeH264SessionParametersGetInfoKHR	set(int sType, long pNext, boolean writeStdSPS, boolean writeStdPPS, int stdSPSId, int stdPPSId)	Initializes this struct with the specified values.
VkVideoEncodeH264SessionParametersGetInfoKHR	set(VkVideoEncodeH264SessionParametersGetInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	stdPPSId()	specifies the H.264 picture parameter set ID used to identify the retrieved H.264 picture parameter set when writeStdPPS is TRUE.
VkVideoEncodeH264SessionParametersGetInfoKHR	stdPPSId(int value)	Sets the specified value to the stdPPSId() field.
int	stdSPSId()	specifies the H.264 sequence parameter set ID used to identify the retrieved H.264 sequence and/or picture parameter set(s).
VkVideoEncodeH264SessionParametersGetInfoKHR	stdSPSId(int value)	Sets the specified value to the stdSPSId() field.
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeH264SessionParametersGetInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeH264SessionParametersGetInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_PARAMETERS_GET_INFO_KHR value to the sType() field.
boolean	writeStdPPS()	indicates whether the encoded H.264 picture parameter set identified by the pair constructed from stdSPSId and stdPPSId is requested to be retrieved.
VkVideoEncodeH264SessionParametersGetInfoKHR	writeStdPPS(boolean value)	Sets the specified value to the writeStdPPS() field.
boolean	writeStdSPS()	indicates whether the encoded H.264 sequence parameter set identified by stdSPSId is requested to be retrieved.
VkVideoEncodeH264SessionParametersGetInfoKHR	writeStdSPS(boolean value)	Sets the specified value to the writeStdSPS() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

WRITESTDSPS

public static final int WRITESTDSPS

The struct member offsets.

WRITESTDPPS

public static final int WRITESTDPPS

The struct member offsets.

STDSPSID

public static final int STDSPSID

The struct member offsets.

STDPPSID

public static final int STDPPSID

The struct member offsets.

Constructor Details

VkVideoEncodeH264SessionParametersGetInfoKHR

public VkVideoEncodeH264SessionParametersGetInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

writeStdSPS

public boolean writeStdSPS()

indicates whether the encoded H.264 sequence parameter set identified by stdSPSId is requested to be retrieved.

writeStdPPS

public boolean writeStdPPS()

indicates whether the encoded H.264 picture parameter set identified by the pair constructed from stdSPSId and stdPPSId is requested to be retrieved.

stdSPSId

public int stdSPSId()

specifies the H.264 sequence parameter set ID used to identify the retrieved H.264 sequence and/or picture parameter set(s).

stdPPSId

public int stdPPSId()

specifies the H.264 picture parameter set ID used to identify the retrieved H.264 picture parameter set when writeStdPPS is TRUE.

sType

public VkVideoEncodeH264SessionParametersGetInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeH264SessionParametersGetInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_H264_SESSION_PARAMETERS_GET_INFO_KHR value to the sType() field.

pNext

public VkVideoEncodeH264SessionParametersGetInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

writeStdSPS

public VkVideoEncodeH264SessionParametersGetInfoKHR writeStdSPS(boolean value)

Sets the specified value to the writeStdSPS() field.

writeStdPPS

public VkVideoEncodeH264SessionParametersGetInfoKHR writeStdPPS(boolean value)

Sets the specified value to the writeStdPPS() field.

stdSPSId

public VkVideoEncodeH264SessionParametersGetInfoKHR stdSPSId(int value)

Sets the specified value to the stdSPSId() field.

stdPPSId

public VkVideoEncodeH264SessionParametersGetInfoKHR stdPPSId(int value)

Sets the specified value to the stdPPSId() field.

set

public VkVideoEncodeH264SessionParametersGetInfoKHR set(int sType,
 long pNext,
 boolean writeStdSPS,
 boolean writeStdPPS,
 int stdSPSId,
 int stdPPSId)

Initializes this struct with the specified values.

set

public VkVideoEncodeH264SessionParametersGetInfoKHR set(VkVideoEncodeH264SessionParametersGetInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeH264SessionParametersGetInfoKHR malloc()

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

calloc

public static VkVideoEncodeH264SessionParametersGetInfoKHR calloc()

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

create

public static VkVideoEncodeH264SessionParametersGetInfoKHR create()

Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeH264SessionParametersGetInfoKHR create(long address)

Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeH264SessionParametersGetInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeH264SessionParametersGetInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkVideoEncodeH264SessionParametersGetInfoKHR.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().

nwriteStdSPS

public static int nwriteStdSPS(long struct)

Unsafe version of writeStdSPS().

nwriteStdPPS

public static int nwriteStdPPS(long struct)

Unsafe version of writeStdPPS().

nstdSPSId

public static int nstdSPSId(long struct)

Unsafe version of stdSPSId().

nstdPPSId

public static int nstdPPSId(long struct)

Unsafe version of stdPPSId().

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.

nwriteStdSPS

public static void nwriteStdSPS(long struct,
 int value)

Unsafe version of writeStdSPS.

nwriteStdPPS

public static void nwriteStdPPS(long struct,
 int value)

Unsafe version of writeStdPPS.

nstdSPSId

public static void nstdSPSId(long struct,
 int value)

Unsafe version of stdSPSId.

nstdPPSId

public static void nstdPPSId(long struct,
 int value)

Unsafe version of stdPPSId.