Package org.lwjgl.vulkan

Class VkVideoEncodeQuantizationMapInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkVideoEncodeQuantizationMapInfoKHR>

org.lwjgl.vulkan.VkVideoEncodeQuantizationMapInfoKHR

All Implemented Interfaces:

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

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

Structure specifying quantization map information to use for video encode operations.

Valid Usage

• quantizationMapExtent.width must be less than or equal to the width of quantizationMap
• quantizationMapExtent.height must be less than or equal to the height of quantizationMap

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_VIDEO_ENCODE_QUANTIZATION_MAP_INFO_KHR
• If quantizationMap is not NULL_HANDLE, quantizationMap must be a valid VkImageView handle

See Also

VkExtent2D

Layout

 struct VkVideoEncodeQuantizationMapInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkImageView quantizationMap();
     VkExtent2D quantizationMapExtent();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeQuantizationMapInfoKHR	calloc()	Returns a new VkVideoEncodeQuantizationMapInfoKHR instance allocated with memCalloc.
static VkVideoEncodeQuantizationMapInfoKHR.Buffer	calloc(int capacity)	Returns a new VkVideoEncodeQuantizationMapInfoKHR.Buffer instance allocated with memCalloc.
static VkVideoEncodeQuantizationMapInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQuantizationMapInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeQuantizationMapInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQuantizationMapInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkVideoEncodeQuantizationMapInfoKHR	create()	Returns a new VkVideoEncodeQuantizationMapInfoKHR instance allocated with BufferUtils.
static VkVideoEncodeQuantizationMapInfoKHR.Buffer	create(int capacity)	Returns a new VkVideoEncodeQuantizationMapInfoKHR.Buffer instance allocated with BufferUtils.
static VkVideoEncodeQuantizationMapInfoKHR	create(long address)	Returns a new VkVideoEncodeQuantizationMapInfoKHR instance for the specified memory address.
static VkVideoEncodeQuantizationMapInfoKHR.Buffer	create(long address, int capacity)	Create a VkVideoEncodeQuantizationMapInfoKHR.Buffer instance at the specified memory.
static @Nullable VkVideoEncodeQuantizationMapInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkVideoEncodeQuantizationMapInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkVideoEncodeQuantizationMapInfoKHR	malloc()	Returns a new VkVideoEncodeQuantizationMapInfoKHR instance allocated with memAlloc.
static VkVideoEncodeQuantizationMapInfoKHR.Buffer	malloc(int capacity)	Returns a new VkVideoEncodeQuantizationMapInfoKHR.Buffer instance allocated with memAlloc.
static VkVideoEncodeQuantizationMapInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQuantizationMapInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkVideoEncodeQuantizationMapInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkVideoEncodeQuantizationMapInfoKHR 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 long	nquantizationMap(long struct)	Unsafe version of quantizationMap().
static void	nquantizationMap(long struct, long value)	Unsafe version of quantizationMap.
static VkExtent2D	nquantizationMapExtent(long struct)	Unsafe version of quantizationMapExtent().
static void	nquantizationMapExtent(long struct, VkExtent2D value)	Unsafe version of quantizationMapExtent.
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.
VkVideoEncodeQuantizationMapInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
long	quantizationMap()	specifies the image view to use as the quantization map.
VkVideoEncodeQuantizationMapInfoKHR	quantizationMap(long value)	Sets the specified value to the quantizationMap() field.
VkExtent2D	quantizationMapExtent()	specifies the extent of the image subregion of quantizationMap to use as the quantization map starting at offset (0,0).
VkVideoEncodeQuantizationMapInfoKHR	quantizationMapExtent(Consumer<VkExtent2D> consumer)	Passes the quantizationMapExtent() field to the specified Consumer.
VkVideoEncodeQuantizationMapInfoKHR	quantizationMapExtent(VkExtent2D value)	Copies the specified VkExtent2D to the quantizationMapExtent() field.
VkVideoEncodeQuantizationMapInfoKHR	set(int sType, long pNext, long quantizationMap, VkExtent2D quantizationMapExtent)	Initializes this struct with the specified values.
VkVideoEncodeQuantizationMapInfoKHR	set(VkVideoEncodeQuantizationMapInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkVideoEncodeQuantizationMapInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkVideoEncodeQuantizationMapInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_VIDEO_ENCODE_QUANTIZATION_MAP_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.

QUANTIZATIONMAP

public static final int QUANTIZATIONMAP

The struct member offsets.

QUANTIZATIONMAPEXTENT

public static final int QUANTIZATIONMAPEXTENT

The struct member offsets.

Constructor Details

VkVideoEncodeQuantizationMapInfoKHR

public VkVideoEncodeQuantizationMapInfoKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

quantizationMap

public long quantizationMap()

specifies the image view to use as the quantization map.

quantizationMapExtent

public VkExtent2D quantizationMapExtent()

specifies the extent of the image subregion of quantizationMap to use as the quantization map starting at offset (0,0).

sType

public VkVideoEncodeQuantizationMapInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkVideoEncodeQuantizationMapInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_ENCODE_QUANTIZATION_MAP_INFO_KHR value to the sType() field.

pNext

public VkVideoEncodeQuantizationMapInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

quantizationMap

public VkVideoEncodeQuantizationMapInfoKHR quantizationMap(long value)

Sets the specified value to the quantizationMap() field.

quantizationMapExtent

public VkVideoEncodeQuantizationMapInfoKHR quantizationMapExtent(VkExtent2D value)

Copies the specified VkExtent2D to the quantizationMapExtent() field.

quantizationMapExtent

public VkVideoEncodeQuantizationMapInfoKHR quantizationMapExtent(Consumer<VkExtent2D> consumer)

Passes the quantizationMapExtent() field to the specified Consumer.

set

public VkVideoEncodeQuantizationMapInfoKHR set(int sType,
 long pNext,
 long quantizationMap,
 VkExtent2D quantizationMapExtent)

Initializes this struct with the specified values.

set

public VkVideoEncodeQuantizationMapInfoKHR set(VkVideoEncodeQuantizationMapInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkVideoEncodeQuantizationMapInfoKHR malloc()

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

calloc

public static VkVideoEncodeQuantizationMapInfoKHR calloc()

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

create

public static VkVideoEncodeQuantizationMapInfoKHR create()

Returns a new VkVideoEncodeQuantizationMapInfoKHR instance allocated with BufferUtils.

create

public static VkVideoEncodeQuantizationMapInfoKHR create(long address)

Returns a new VkVideoEncodeQuantizationMapInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkVideoEncodeQuantizationMapInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkVideoEncodeQuantizationMapInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkVideoEncodeQuantizationMapInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkVideoEncodeQuantizationMapInfoKHR.Buffer create(int capacity)

Returns a new VkVideoEncodeQuantizationMapInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkVideoEncodeQuantizationMapInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkVideoEncodeQuantizationMapInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nquantizationMap

public static long nquantizationMap(long struct)

Unsafe version of quantizationMap().

nquantizationMapExtent

public static VkExtent2D nquantizationMapExtent(long struct)

Unsafe version of quantizationMapExtent().

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.

nquantizationMap

public static void nquantizationMap(long struct,
 long value)

Unsafe version of quantizationMap.

nquantizationMapExtent

public static void nquantizationMapExtent(long struct,
 VkExtent2D value)

Unsafe version of quantizationMapExtent.