Package org.lwjgl.vulkan

Class VkVideoEncodeAV1SessionCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeAV1SessionCreateInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeAV1SessionCreateInfoKHR

All Implemented Interfaces:

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

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

Structure specifies AV1 encode session parameters.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_AV1_SESSION_CREATE_INFO_KHR

Layout

 struct VkVideoEncodeAV1SessionCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkBool32 useMaxLevel();
     StdVideoAV1Level maxLevel();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoEncodeAV1SessionCreateInfoKHR.Buffer	An array of VkVideoEncodeAV1SessionCreateInfoKHR 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	MAXLEVEL	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	USEMAXLEVEL	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
VkVideoEncodeAV1SessionCreateInfoKHR(ByteBuffer container)	Creates a VkVideoEncodeAV1SessionCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeAV1SessionCreateInfoKHR	calloc()	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR instance allocated with memCalloc.
static VkVideoEncodeAV1SessionCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeAV1SessionCreateInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeAV1SessionCreateInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeAV1SessionCreateInfoKHR	create()	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeAV1SessionCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeAV1SessionCreateInfoKHR	create(long address)	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR instance for the specified memory address.
static VkVideoEncodeAV1SessionCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeAV1SessionCreateInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeAV1SessionCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeAV1SessionCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoEncodeAV1SessionCreateInfoKHR	malloc()	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR instance allocated with memAlloc.
static VkVideoEncodeAV1SessionCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeAV1SessionCreateInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeAV1SessionCreateInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeAV1SessionCreateInfoKHR instance allocated on the specified MemoryStack.
int	maxLevel()	a StdVideoAV1Level value specifying the upper bound on the AV1 level for the video bitstreams produced by the created video session.
VkVideoEncodeAV1SessionCreateInfoKHR	maxLevel(int value)	Sets the specified value to the maxLevel() field.
static int	nmaxLevel(long struct)	Unsafe version of maxLevel().
static void	nmaxLevel(long struct, int value)	Unsafe version of maxLevel.
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	nuseMaxLevel(long struct)	Unsafe version of useMaxLevel().
static void	nuseMaxLevel(long struct, int value)	Unsafe version of useMaxLevel.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoEncodeAV1SessionCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoEncodeAV1SessionCreateInfoKHR	set(int sType, long pNext, boolean useMaxLevel, int maxLevel)	Initializes this struct with the specified values.
VkVideoEncodeAV1SessionCreateInfoKHR	set(VkVideoEncodeAV1SessionCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeAV1SessionCreateInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeAV1SessionCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_AV1_SESSION_CREATE_INFO_KHR value to the sType() field.
boolean	useMaxLevel()	indicates whether the value of maxLevel should be used by the implementation.
VkVideoEncodeAV1SessionCreateInfoKHR	useMaxLevel(boolean value)	Sets the specified value to the useMaxLevel() 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.

USEMAXLEVEL

public static final int USEMAXLEVEL

The struct member offsets.

MAXLEVEL

public static final int MAXLEVEL

The struct member offsets.

Constructor Details

VkVideoEncodeAV1SessionCreateInfoKHR

public VkVideoEncodeAV1SessionCreateInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

useMaxLevel

public boolean useMaxLevel()

indicates whether the value of maxLevel should be used by the implementation. When it is set to FALSE, the implementation ignores the value of maxLevel and uses the value of VkVideoEncodeAV1CapabilitiesKHR::maxLevel, as reported by GetPhysicalDeviceVideoCapabilitiesKHR for the video profile.

maxLevel

public int maxLevel()

a StdVideoAV1Level value specifying the upper bound on the AV1 level for the video bitstreams produced by the created video session.

sType

public VkVideoEncodeAV1SessionCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeAV1SessionCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_AV1_SESSION_CREATE_INFO_KHR value to the sType() field.

pNext

public VkVideoEncodeAV1SessionCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

useMaxLevel

public VkVideoEncodeAV1SessionCreateInfoKHR useMaxLevel(boolean value)

Sets the specified value to the useMaxLevel() field.

maxLevel

public VkVideoEncodeAV1SessionCreateInfoKHR maxLevel(int value)

Sets the specified value to the maxLevel() field.

set

public VkVideoEncodeAV1SessionCreateInfoKHR set(int sType,
 long pNext,
 boolean useMaxLevel,
 int maxLevel)

Initializes this struct with the specified values.

set

public VkVideoEncodeAV1SessionCreateInfoKHR set(VkVideoEncodeAV1SessionCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeAV1SessionCreateInfoKHR malloc()

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

calloc

public static VkVideoEncodeAV1SessionCreateInfoKHR calloc()

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

create

public static VkVideoEncodeAV1SessionCreateInfoKHR create()

Returns a new VkVideoEncodeAV1SessionCreateInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeAV1SessionCreateInfoKHR create(long address)

Returns a new VkVideoEncodeAV1SessionCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeAV1SessionCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeAV1SessionCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeAV1SessionCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeAV1SessionCreateInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeAV1SessionCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeAV1SessionCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeAV1SessionCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nuseMaxLevel

public static int nuseMaxLevel(long struct)

Unsafe version of useMaxLevel().

nmaxLevel

public static int nmaxLevel(long struct)

Unsafe version of maxLevel().

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.

nuseMaxLevel

public static void nuseMaxLevel(long struct,
 int value)

Unsafe version of useMaxLevel.

nmaxLevel

public static void nmaxLevel(long struct,
 int value)

Unsafe version of maxLevel.