Package org.lwjgl.vulkan

Class VkVideoFormatQuantizationMapPropertiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoFormatQuantizationMapPropertiesKHR>

org.lwjgl.vulkan.VkVideoFormatQuantizationMapPropertiesKHR

All Implemented Interfaces:

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

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

Structure describing 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.

Implementations may support multiple quantization map texel sizes for a particular video format which is indicated by GetPhysicalDeviceVideoFormatPropertiesKHR returning multiple entries with different quantizationMapTexelSize values.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_FORMAT_QUANTIZATION_MAP_PROPERTIES_KHR

See Also

VkExtent2D

Layout

 struct VkVideoFormatQuantizationMapPropertiesKHR {
     VkStructureType sType();
     void * pNext();
     VkExtent2D quantizationMapTexelSize();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkVideoFormatQuantizationMapPropertiesKHR	calloc()	Returns a new VkVideoFormatQuantizationMapPropertiesKHR instance allocated with memCalloc.
static VkVideoFormatQuantizationMapPropertiesKHR.Buffer	calloc(int capacity)	Returns a new VkVideoFormatQuantizationMapPropertiesKHR.Buffer instance allocated with memCalloc.
static VkVideoFormatQuantizationMapPropertiesKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoFormatQuantizationMapPropertiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoFormatQuantizationMapPropertiesKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoFormatQuantizationMapPropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoFormatQuantizationMapPropertiesKHR	create()	Returns a new VkVideoFormatQuantizationMapPropertiesKHR instance allocated with BufferUtils.
static VkVideoFormatQuantizationMapPropertiesKHR.Buffer	create(int capacity)	Returns a new VkVideoFormatQuantizationMapPropertiesKHR.Buffer instance allocated with BufferUtils.
static VkVideoFormatQuantizationMapPropertiesKHR	create(long address)	Returns a new VkVideoFormatQuantizationMapPropertiesKHR instance for the specified memory address.
static VkVideoFormatQuantizationMapPropertiesKHR.Buffer	create(long address, int capacity)	Create a VkVideoFormatQuantizationMapPropertiesKHR.Buffer instance at the specified memory.
static @Nullable VkVideoFormatQuantizationMapPropertiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoFormatQuantizationMapPropertiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoFormatQuantizationMapPropertiesKHR	malloc()	Returns a new VkVideoFormatQuantizationMapPropertiesKHR instance allocated with memAlloc.
static VkVideoFormatQuantizationMapPropertiesKHR.Buffer	malloc(int capacity)	Returns a new VkVideoFormatQuantizationMapPropertiesKHR.Buffer instance allocated with memAlloc.
static VkVideoFormatQuantizationMapPropertiesKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoFormatQuantizationMapPropertiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoFormatQuantizationMapPropertiesKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoFormatQuantizationMapPropertiesKHR 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 VkExtent2D	nquantizationMapTexelSize(long struct)	Unsafe version of quantizationMapTexelSize().
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.
VkVideoFormatQuantizationMapPropertiesKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkExtent2D	quantizationMapTexelSize()	indicates the quantization map texel size of the video format, i.e.
VkVideoFormatQuantizationMapPropertiesKHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkVideoFormatQuantizationMapPropertiesKHR	set(VkVideoFormatQuantizationMapPropertiesKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoFormatQuantizationMapPropertiesKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoFormatQuantizationMapPropertiesKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_FORMAT_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.

QUANTIZATIONMAPTEXELSIZE

public static final int QUANTIZATIONMAPTEXELSIZE

The struct member offsets.

Constructor Details

VkVideoFormatQuantizationMapPropertiesKHR

public VkVideoFormatQuantizationMapPropertiesKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

quantizationMapTexelSize

public VkExtent2D quantizationMapTexelSize()

indicates the quantization map texel size of the video format, i.e. the number of pixels corresponding to each quantization map texel.

sType

public VkVideoFormatQuantizationMapPropertiesKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoFormatQuantizationMapPropertiesKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_FORMAT_QUANTIZATION_MAP_PROPERTIES_KHR value to the sType() field.

pNext

public VkVideoFormatQuantizationMapPropertiesKHR pNext(long value)

Sets the specified value to the pNext() field.

set

public VkVideoFormatQuantizationMapPropertiesKHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkVideoFormatQuantizationMapPropertiesKHR set(VkVideoFormatQuantizationMapPropertiesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoFormatQuantizationMapPropertiesKHR malloc()

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

calloc

public static VkVideoFormatQuantizationMapPropertiesKHR calloc()

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

create

public static VkVideoFormatQuantizationMapPropertiesKHR create()

Returns a new VkVideoFormatQuantizationMapPropertiesKHR instance allocated with BufferUtils.

create

public static VkVideoFormatQuantizationMapPropertiesKHR create(long address)

Returns a new VkVideoFormatQuantizationMapPropertiesKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoFormatQuantizationMapPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoFormatQuantizationMapPropertiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoFormatQuantizationMapPropertiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoFormatQuantizationMapPropertiesKHR.Buffer create(int capacity)

Returns a new VkVideoFormatQuantizationMapPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoFormatQuantizationMapPropertiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoFormatQuantizationMapPropertiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nquantizationMapTexelSize

public static VkExtent2D nquantizationMapTexelSize(long struct)

Unsafe version of quantizationMapTexelSize().

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.