Package org.lwjgl.vulkan

Class VkVideoDecodeAV1ProfileInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoDecodeAV1ProfileInfoKHR>

org.lwjgl.vulkan.VkVideoDecodeAV1ProfileInfoKHR

All Implemented Interfaces:

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

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

Structure specifying AV1 decode profile.

Description

Note

Enabling filmGrainSupport may increase the memory requirements of video sessions and/or video picture resources on some implementations.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_DECODE_AV1_PROFILE_INFO_KHR

Layout

 struct VkVideoDecodeAV1ProfileInfoKHR {
     VkStructureType sType();
     void const * pNext();
     StdVideoAV1Profile stdProfile();
     VkBool32 filmGrainSupport();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkVideoDecodeAV1ProfileInfoKHR	calloc()	Returns a new VkVideoDecodeAV1ProfileInfoKHR instance allocated with memCalloc.
static VkVideoDecodeAV1ProfileInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoDecodeAV1ProfileInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoDecodeAV1ProfileInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoDecodeAV1ProfileInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoDecodeAV1ProfileInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoDecodeAV1ProfileInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoDecodeAV1ProfileInfoKHR	create()	Returns a new VkVideoDecodeAV1ProfileInfoKHR instance allocated with BufferUtils.
static VkVideoDecodeAV1ProfileInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoDecodeAV1ProfileInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoDecodeAV1ProfileInfoKHR	create(long address)	Returns a new VkVideoDecodeAV1ProfileInfoKHR instance for the specified memory address.
static VkVideoDecodeAV1ProfileInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoDecodeAV1ProfileInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoDecodeAV1ProfileInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoDecodeAV1ProfileInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	filmGrainSupport()	specifies whether AV1 film grain, as defined in section 7.8.3 of the AV1 Specification, can be used with the video profile.
VkVideoDecodeAV1ProfileInfoKHR	filmGrainSupport(boolean value)	Sets the specified value to the filmGrainSupport() field.
static VkVideoDecodeAV1ProfileInfoKHR	malloc()	Returns a new VkVideoDecodeAV1ProfileInfoKHR instance allocated with memAlloc.
static VkVideoDecodeAV1ProfileInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoDecodeAV1ProfileInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoDecodeAV1ProfileInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoDecodeAV1ProfileInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoDecodeAV1ProfileInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoDecodeAV1ProfileInfoKHR instance allocated on the specified MemoryStack.
static int	nfilmGrainSupport(long struct)	Unsafe version of filmGrainSupport().
static void	nfilmGrainSupport(long struct, int value)	Unsafe version of filmGrainSupport.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nstdProfile(long struct)	Unsafe version of stdProfile().
static void	nstdProfile(long struct, int value)	Unsafe version of stdProfile.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoDecodeAV1ProfileInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoDecodeAV1ProfileInfoKHR	set(int sType, long pNext, int stdProfile, boolean filmGrainSupport)	Initializes this struct with the specified values.
VkVideoDecodeAV1ProfileInfoKHR	set(VkVideoDecodeAV1ProfileInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	stdProfile()	a StdVideoAV1Profile value specifying the AV1 codec profile, as defined in section A.2 of the AV1 Specification.
VkVideoDecodeAV1ProfileInfoKHR	stdProfile(int value)	Sets the specified value to the stdProfile() field.
int	sType()	a VkStructureType value identifying this structure.
VkVideoDecodeAV1ProfileInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoDecodeAV1ProfileInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_DECODE_AV1_PROFILE_INFO_KHR value to the sType() 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.

STDPROFILE

public static final int STDPROFILE

The struct member offsets.

FILMGRAINSUPPORT

public static final int FILMGRAINSUPPORT

The struct member offsets.

Constructor Details

VkVideoDecodeAV1ProfileInfoKHR

public VkVideoDecodeAV1ProfileInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

stdProfile

public int stdProfile()

a StdVideoAV1Profile value specifying the AV1 codec profile, as defined in section A.2 of the AV1 Specification.

filmGrainSupport

public boolean filmGrainSupport()

specifies whether AV1 film grain, as defined in section 7.8.3 of the AV1 Specification, can be used with the video profile. When this member is TRUE, video session objects created against the video profile will be able to decode pictures that have film grain enabled.

sType

public VkVideoDecodeAV1ProfileInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoDecodeAV1ProfileInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_DECODE_AV1_PROFILE_INFO_KHR value to the sType() field.

pNext

public VkVideoDecodeAV1ProfileInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

stdProfile

public VkVideoDecodeAV1ProfileInfoKHR stdProfile(int value)

Sets the specified value to the stdProfile() field.

filmGrainSupport

public VkVideoDecodeAV1ProfileInfoKHR filmGrainSupport(boolean value)

Sets the specified value to the filmGrainSupport() field.

set

public VkVideoDecodeAV1ProfileInfoKHR set(int sType,
 long pNext,
 int stdProfile,
 boolean filmGrainSupport)

Initializes this struct with the specified values.

set

public VkVideoDecodeAV1ProfileInfoKHR set(VkVideoDecodeAV1ProfileInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoDecodeAV1ProfileInfoKHR malloc()

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

calloc

public static VkVideoDecodeAV1ProfileInfoKHR calloc()

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

create

public static VkVideoDecodeAV1ProfileInfoKHR create()

Returns a new VkVideoDecodeAV1ProfileInfoKHR instance allocated with BufferUtils.

create

public static VkVideoDecodeAV1ProfileInfoKHR create(long address)

Returns a new VkVideoDecodeAV1ProfileInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoDecodeAV1ProfileInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoDecodeAV1ProfileInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoDecodeAV1ProfileInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoDecodeAV1ProfileInfoKHR.Buffer create(int capacity)

Returns a new VkVideoDecodeAV1ProfileInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoDecodeAV1ProfileInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoDecodeAV1ProfileInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nstdProfile

public static int nstdProfile(long struct)

Unsafe version of stdProfile().

nfilmGrainSupport

public static int nfilmGrainSupport(long struct)

Unsafe version of filmGrainSupport().

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.

nstdProfile

public static void nstdProfile(long struct,
 int value)

Unsafe version of stdProfile.

nfilmGrainSupport

public static void nfilmGrainSupport(long struct,
 int value)

Unsafe version of filmGrainSupport.