Package org.lwjgl.vulkan

Class VkVideoFormatAV1QuantizationMapPropertiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoFormatAV1QuantizationMapPropertiesKHR>

org.lwjgl.vulkan.VkVideoFormatAV1QuantizationMapPropertiesKHR

All Implemented Interfaces:

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

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

Structure describing AV1 quantization map properties.

Description

The values returned in this structure are only defined if the allowed image usage flags returned in VkVideoFormatPropertiesKHR::imageUsageFlags for this video format include IMAGE_USAGE_VIDEO_ENCODE_QUANTIZATION_DELTA_MAP_BIT_KHR or IMAGE_USAGE_VIDEO_ENCODE_EMPHASIS_MAP_BIT_KHR.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_FORMAT_AV1_QUANTIZATION_MAP_PROPERTIES_KHR

Layout

 struct VkVideoFormatAV1QuantizationMapPropertiesKHR {
     VkStructureType sType();
     void * pNext();
     VkVideoEncodeAV1SuperblockSizeFlagsKHR compatibleSuperblockSizes();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer	An array of VkVideoFormatAV1QuantizationMapPropertiesKHR 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	COMPATIBLESUPERBLOCKSIZES	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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkVideoFormatAV1QuantizationMapPropertiesKHR(ByteBuffer container)	Creates a VkVideoFormatAV1QuantizationMapPropertiesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkVideoFormatAV1QuantizationMapPropertiesKHR	calloc()	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR instance allocated with memCalloc.
static VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer	calloc(int capacity)	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer instance allocated with memCalloc.
static VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoFormatAV1QuantizationMapPropertiesKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	compatibleSuperblockSizes()	a bitmask of VkVideoEncodeAV1SuperblockSizeFlagBitsKHR indicating the AV1 superblock sizes that quantization maps using this video format are compatible with.
static VkVideoFormatAV1QuantizationMapPropertiesKHR	create()	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR instance allocated with BufferUtils.
static VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer	create(int capacity)	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer instance allocated with BufferUtils.
static VkVideoFormatAV1QuantizationMapPropertiesKHR	create(long address)	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR instance for the specified memory address.
static VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer	create(long address, int capacity)	Create a VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer instance at the specified memory.
static @Nullable VkVideoFormatAV1QuantizationMapPropertiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoFormatAV1QuantizationMapPropertiesKHR	malloc()	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR instance allocated with memAlloc.
static VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer	malloc(int capacity)	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer instance allocated with memAlloc.
static VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoFormatAV1QuantizationMapPropertiesKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR instance allocated on the specified MemoryStack.
static int	ncompatibleSuperblockSizes(long struct)	Unsafe version of compatibleSuperblockSizes().
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkVideoFormatAV1QuantizationMapPropertiesKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkVideoFormatAV1QuantizationMapPropertiesKHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkVideoFormatAV1QuantizationMapPropertiesKHR	set(VkVideoFormatAV1QuantizationMapPropertiesKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoFormatAV1QuantizationMapPropertiesKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoFormatAV1QuantizationMapPropertiesKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_FORMAT_AV1_QUANTIZATION_MAP_PROPERTIES_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.

COMPATIBLESUPERBLOCKSIZES

public static final int COMPATIBLESUPERBLOCKSIZES

The struct member offsets.

Constructor Details

VkVideoFormatAV1QuantizationMapPropertiesKHR

public VkVideoFormatAV1QuantizationMapPropertiesKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

compatibleSuperblockSizes

public int compatibleSuperblockSizes()

a bitmask of VkVideoEncodeAV1SuperblockSizeFlagBitsKHR indicating the AV1 superblock sizes that quantization maps using this video format are compatible with.

Note

The value of compatibleSuperblockSizes does not limit the use of the specific quantization map format, but does limit the implementation in being able to encode pictures with superblock sizes not included in compatibleSuperblockSizes but otherwise supported by the used video profile, as indicated by VkVideoEncodeAV1CapabilitiesKHR::superblockSizes. In particular, using smaller quantization map texel sizes may prevent implementations from encoding with larger superblock sizes which may have a negative impact on the efficiency of the encoder.

sType

public VkVideoFormatAV1QuantizationMapPropertiesKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoFormatAV1QuantizationMapPropertiesKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_FORMAT_AV1_QUANTIZATION_MAP_PROPERTIES_KHR value to the sType() field.

pNext

public VkVideoFormatAV1QuantizationMapPropertiesKHR pNext(long value)

Sets the specified value to the pNext() field.

set

public VkVideoFormatAV1QuantizationMapPropertiesKHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkVideoFormatAV1QuantizationMapPropertiesKHR set(VkVideoFormatAV1QuantizationMapPropertiesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoFormatAV1QuantizationMapPropertiesKHR malloc()

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

calloc

public static VkVideoFormatAV1QuantizationMapPropertiesKHR calloc()

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

create

public static VkVideoFormatAV1QuantizationMapPropertiesKHR create()

Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR instance allocated with BufferUtils.

create

public static VkVideoFormatAV1QuantizationMapPropertiesKHR create(long address)

Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoFormatAV1QuantizationMapPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer create(int capacity)

Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoFormatAV1QuantizationMapPropertiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoFormatAV1QuantizationMapPropertiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncompatibleSuperblockSizes

public static int ncompatibleSuperblockSizes(long struct)

Unsafe version of compatibleSuperblockSizes().

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.