Package org.lwjgl.vulkan

Class VkVideoEncodeSessionParametersGetInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeSessionParametersGetInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeSessionParametersGetInfoKHR

All Implemented Interfaces:

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

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

Structure specifying parameters for retrieving encoded video session parameter data.

Description

Depending on the used video encode operation, additional codec-specific structures may need to be included in the pNext chain of this structure to identify the specific video session parameters to retrieve encoded parameter data for, as described in the corresponding sections.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_SESSION_PARAMETERS_GET_INFO_KHR
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkVideoEncodeH264SessionParametersGetInfoKHR or VkVideoEncodeH265SessionParametersGetInfoKHR
• The sType value of each struct in the pNext chain must be unique
• videoSessionParameters must be a valid VkVideoSessionParametersKHR handle

See Also

GetEncodedVideoSessionParametersKHR

Layout

 struct VkVideoEncodeSessionParametersGetInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkVideoSessionParametersKHR videoSessionParameters();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeSessionParametersGetInfoKHR.Buffer	An array of VkVideoEncodeSessionParametersGetInfoKHR 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	STYPE	The struct member offsets.
static final int	VIDEOSESSIONPARAMETERS	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
VkVideoEncodeSessionParametersGetInfoKHR(ByteBuffer container)	Creates a VkVideoEncodeSessionParametersGetInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeSessionParametersGetInfoKHR	calloc()	Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated with memCalloc.
static VkVideoEncodeSessionParametersGetInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeSessionParametersGetInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeSessionParametersGetInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeSessionParametersGetInfoKHR	create()	Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeSessionParametersGetInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeSessionParametersGetInfoKHR	create(long address)	Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance for the specified memory address.
static VkVideoEncodeSessionParametersGetInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeSessionParametersGetInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeSessionParametersGetInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoEncodeSessionParametersGetInfoKHR	malloc()	Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated with memAlloc.
static VkVideoEncodeSessionParametersGetInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeSessionParametersGetInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeSessionParametersGetInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeSessionParametersGetInfoKHR 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	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static long	nvideoSessionParameters(long struct)	Unsafe version of videoSessionParameters().
static void	nvideoSessionParameters(long struct, long value)	Unsafe version of videoSessionParameters.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoEncodeSessionParametersGetInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoEncodeSessionParametersGetInfoKHR	pNext(VkVideoEncodeH264SessionParametersGetInfoKHR value)	Prepends the specified VkVideoEncodeH264SessionParametersGetInfoKHR value to the pNext chain.
VkVideoEncodeSessionParametersGetInfoKHR	pNext(VkVideoEncodeH265SessionParametersGetInfoKHR value)	Prepends the specified VkVideoEncodeH265SessionParametersGetInfoKHR value to the pNext chain.
VkVideoEncodeSessionParametersGetInfoKHR	set(int sType, long pNext, long videoSessionParameters)	Initializes this struct with the specified values.
VkVideoEncodeSessionParametersGetInfoKHR	set(VkVideoEncodeSessionParametersGetInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeSessionParametersGetInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeSessionParametersGetInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_SESSION_PARAMETERS_GET_INFO_KHR value to the sType() field.
long	videoSessionParameters()	the VkVideoSessionParametersKHR object to retrieve encoded parameter data from.
VkVideoEncodeSessionParametersGetInfoKHR	videoSessionParameters(long value)	Sets the specified value to the videoSessionParameters() 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.

VIDEOSESSIONPARAMETERS

public static final int VIDEOSESSIONPARAMETERS

The struct member offsets.

Constructor Details

VkVideoEncodeSessionParametersGetInfoKHR

public VkVideoEncodeSessionParametersGetInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

videoSessionParameters

public long videoSessionParameters()

the VkVideoSessionParametersKHR object to retrieve encoded parameter data from.

sType

public VkVideoEncodeSessionParametersGetInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeSessionParametersGetInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_SESSION_PARAMETERS_GET_INFO_KHR value to the sType() field.

pNext

public VkVideoEncodeSessionParametersGetInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkVideoEncodeSessionParametersGetInfoKHR pNext(VkVideoEncodeH264SessionParametersGetInfoKHR value)

Prepends the specified VkVideoEncodeH264SessionParametersGetInfoKHR value to the pNext chain.

pNext

public VkVideoEncodeSessionParametersGetInfoKHR pNext(VkVideoEncodeH265SessionParametersGetInfoKHR value)

Prepends the specified VkVideoEncodeH265SessionParametersGetInfoKHR value to the pNext chain.

videoSessionParameters

public VkVideoEncodeSessionParametersGetInfoKHR videoSessionParameters(long value)

Sets the specified value to the videoSessionParameters() field.

set

public VkVideoEncodeSessionParametersGetInfoKHR set(int sType,
 long pNext,
 long videoSessionParameters)

Initializes this struct with the specified values.

set

public VkVideoEncodeSessionParametersGetInfoKHR set(VkVideoEncodeSessionParametersGetInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeSessionParametersGetInfoKHR malloc()

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

calloc

public static VkVideoEncodeSessionParametersGetInfoKHR calloc()

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

create

public static VkVideoEncodeSessionParametersGetInfoKHR create()

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeSessionParametersGetInfoKHR create(long address)

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeSessionParametersGetInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeSessionParametersGetInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeSessionParametersGetInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeSessionParametersGetInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeSessionParametersGetInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeSessionParametersGetInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nvideoSessionParameters

public static long nvideoSessionParameters(long struct)

Unsafe version of videoSessionParameters().

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.

nvideoSessionParameters

public static void nvideoSessionParameters(long struct,
 long value)

Unsafe version of videoSessionParameters.