Package org.lwjgl.vulkan

Class VkHdrVividDynamicMetadataHUAWEI

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkHdrVividDynamicMetadataHUAWEI>

org.lwjgl.vulkan.VkHdrVividDynamicMetadataHUAWEI

All Implemented Interfaces:

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

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

specify HDR Vivid dynamic metadata.

Description

Note

The HDR Vivid metadata is intended to be used as defined in the T/UWA 005.1-2022 specification. The validity and use of this data is outside the scope of Vulkan.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_HDR_VIVID_DYNAMIC_METADATA_HUAWEI
• pDynamicMetadata must be a valid pointer to an array of dynamicMetadataSize bytes
• dynamicMetadataSize must be greater than 0

Layout

 struct VkHdrVividDynamicMetadataHUAWEI {
     VkStructureType sType();
     void const * pNext();
     size_t dynamicMetadataSize();
     void const * pDynamicMetadata();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkHdrVividDynamicMetadataHUAWEI	calloc()	Returns a new VkHdrVividDynamicMetadataHUAWEI instance allocated with memCalloc.
static VkHdrVividDynamicMetadataHUAWEI.Buffer	calloc(int capacity)	Returns a new VkHdrVividDynamicMetadataHUAWEI.Buffer instance allocated with memCalloc.
static VkHdrVividDynamicMetadataHUAWEI.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkHdrVividDynamicMetadataHUAWEI.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkHdrVividDynamicMetadataHUAWEI	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkHdrVividDynamicMetadataHUAWEI instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkHdrVividDynamicMetadataHUAWEI	create()	Returns a new VkHdrVividDynamicMetadataHUAWEI instance allocated with BufferUtils.
static VkHdrVividDynamicMetadataHUAWEI.Buffer	create(int capacity)	Returns a new VkHdrVividDynamicMetadataHUAWEI.Buffer instance allocated with BufferUtils.
static VkHdrVividDynamicMetadataHUAWEI	create(long address)	Returns a new VkHdrVividDynamicMetadataHUAWEI instance for the specified memory address.
static VkHdrVividDynamicMetadataHUAWEI.Buffer	create(long address, int capacity)	Create a VkHdrVividDynamicMetadataHUAWEI.Buffer instance at the specified memory.
static @Nullable VkHdrVividDynamicMetadataHUAWEI	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkHdrVividDynamicMetadataHUAWEI.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	dynamicMetadataSize()	the size in bytes of the dynamic metadata.
static VkHdrVividDynamicMetadataHUAWEI	malloc()	Returns a new VkHdrVividDynamicMetadataHUAWEI instance allocated with memAlloc.
static VkHdrVividDynamicMetadataHUAWEI.Buffer	malloc(int capacity)	Returns a new VkHdrVividDynamicMetadataHUAWEI.Buffer instance allocated with memAlloc.
static VkHdrVividDynamicMetadataHUAWEI.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkHdrVividDynamicMetadataHUAWEI.Buffer instance allocated on the specified MemoryStack.
static VkHdrVividDynamicMetadataHUAWEI	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkHdrVividDynamicMetadataHUAWEI instance allocated on the specified MemoryStack.
static long	ndynamicMetadataSize(long struct)	Unsafe version of dynamicMetadataSize().
static void	ndynamicMetadataSize(long struct, long value)	Sets the specified value to the dynamicMetadataSize field of the specified struct.
static ByteBuffer	npDynamicMetadata(long struct)	Unsafe version of pDynamicMetadata.
static void	npDynamicMetadata(long struct, ByteBuffer value)	Unsafe version of pDynamicMetadata.
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.
ByteBuffer	pDynamicMetadata()	a pointer to the dynamic metadata.
VkHdrVividDynamicMetadataHUAWEI	pDynamicMetadata(ByteBuffer value)	Sets the address of the specified ByteBuffer to the pDynamicMetadata() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkHdrVividDynamicMetadataHUAWEI	pNext(long value)	Sets the specified value to the pNext() field.
VkHdrVividDynamicMetadataHUAWEI	set(int sType, long pNext, ByteBuffer pDynamicMetadata)	Initializes this struct with the specified values.
VkHdrVividDynamicMetadataHUAWEI	set(VkHdrVividDynamicMetadataHUAWEI src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkHdrVividDynamicMetadataHUAWEI	sType(int value)	Sets the specified value to the sType() field.
VkHdrVividDynamicMetadataHUAWEI	sType$Default()	Sets the STRUCTURE_TYPE_HDR_VIVID_DYNAMIC_METADATA_HUAWEI value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

DYNAMICMETADATASIZE

public static final int DYNAMICMETADATASIZE

The struct member offsets.

PDYNAMICMETADATA

public static final int PDYNAMICMETADATA

The struct member offsets.

Constructor Details

VkHdrVividDynamicMetadataHUAWEI

public VkHdrVividDynamicMetadataHUAWEI(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

dynamicMetadataSize

public long dynamicMetadataSize()

the size in bytes of the dynamic metadata.

pDynamicMetadata

public ByteBuffer pDynamicMetadata()

a pointer to the dynamic metadata.

sType

public VkHdrVividDynamicMetadataHUAWEI sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkHdrVividDynamicMetadataHUAWEI sType$Default()

Sets the STRUCTURE_TYPE_HDR_VIVID_DYNAMIC_METADATA_HUAWEI value to the sType() field.

pNext

public VkHdrVividDynamicMetadataHUAWEI pNext(long value)

Sets the specified value to the pNext() field.

pDynamicMetadata

public VkHdrVividDynamicMetadataHUAWEI pDynamicMetadata(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pDynamicMetadata() field.

set

public VkHdrVividDynamicMetadataHUAWEI set(int sType,
 long pNext,
 ByteBuffer pDynamicMetadata)

Initializes this struct with the specified values.

set

public VkHdrVividDynamicMetadataHUAWEI set(VkHdrVividDynamicMetadataHUAWEI src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkHdrVividDynamicMetadataHUAWEI malloc()

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

calloc

public static VkHdrVividDynamicMetadataHUAWEI calloc()

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

create

public static VkHdrVividDynamicMetadataHUAWEI create()

Returns a new VkHdrVividDynamicMetadataHUAWEI instance allocated with BufferUtils.

create

public static VkHdrVividDynamicMetadataHUAWEI create(long address)

Returns a new VkHdrVividDynamicMetadataHUAWEI instance for the specified memory address.

createSafe

public static @Nullable VkHdrVividDynamicMetadataHUAWEI createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkHdrVividDynamicMetadataHUAWEI.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkHdrVividDynamicMetadataHUAWEI.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkHdrVividDynamicMetadataHUAWEI.Buffer create(int capacity)

Returns a new VkHdrVividDynamicMetadataHUAWEI.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkHdrVividDynamicMetadataHUAWEI.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkHdrVividDynamicMetadataHUAWEI instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndynamicMetadataSize

public static long ndynamicMetadataSize(long struct)

Unsafe version of dynamicMetadataSize().

npDynamicMetadata

public static ByteBuffer npDynamicMetadata(long struct)

Unsafe version of pDynamicMetadata.

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.

ndynamicMetadataSize

public static void ndynamicMetadataSize(long struct,
 long value)

Sets the specified value to the dynamicMetadataSize field of the specified struct.

npDynamicMetadata

public static void npDynamicMetadata(long struct,
 ByteBuffer value)

Unsafe version of pDynamicMetadata.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate