Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkHdrMetadataEXT

extends Struct<VkHdrMetadataEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Specify Hdr metadata.
Valid Usage (Implicit)
Note

The validity and use of this data is outside the scope of Vulkan.

See Also

VkXYColorEXT, SetHdrMetadataEXT

Layout


struct VkHdrMetadataEXT {
    VkStructureType sType;
    void const * pNext;
    VkXYColorEXT displayPrimaryRed;
    VkXYColorEXT displayPrimaryGreen;
    VkXYColorEXT displayPrimaryBlue;
    VkXYColorEXT whitePoint;
    float maxLuminance;
    float minLuminance;
    float maxContentLightLevel;
    float maxFrameAverageLightLevel;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkHdrMetadataEXT.Buffer

An array of VkHdrMetadataEXT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DISPLAYPRIMARYBLUE

The struct member offsets.

public static final int
DISPLAYPRIMARYGREEN

The struct member offsets.

public static final int
DISPLAYPRIMARYRED

The struct member offsets.

public static final int
MAXCONTENTLIGHTLEVEL

The struct member offsets.

public static final int
MAXFRAMEAVERAGELIGHTLEVEL

The struct member offsets.

public static final int
MAXLUMINANCE

The struct member offsets.

public static final int
MINLUMINANCE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
WHITEPOINT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkHdrMetadataEXT(long address, ByteBuffer container)

public
VkHdrMetadataEXT(ByteBuffer container)

Creates a VkHdrMetadataEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkHdrMetadataEXT
calloc()

Returns a new VkHdrMetadataEXT instance allocated with memCalloc.

public static VkHdrMetadataEXT.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkHdrMetadataEXT.Buffer instance allocated with memCalloc.

public static VkHdrMetadataEXT
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static VkHdrMetadataEXT.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkHdrMetadataEXT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkHdrMetadataEXT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkHdrMetadataEXT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkHdrMetadataEXT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkHdrMetadataEXT
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkHdrMetadataEXT
create()

Returns a new VkHdrMetadataEXT instance allocated with BufferUtils.

public static VkHdrMetadataEXT
create(long address)

Returns a new VkHdrMetadataEXT instance for the specified memory address.

public static VkHdrMetadataEXT.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkHdrMetadataEXT.Buffer instance allocated with BufferUtils.

public static VkHdrMetadataEXT.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkHdrMetadataEXT.Buffer instance at the specified memory.

public static VkHdrMetadataEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkHdrMetadataEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public VkXYColorEXT
displayPrimaryBlue()

a VkXYColorEXT structure specifying the reference monitor’s blue primary in chromaticity coordinates

public VkHdrMetadataEXT
displayPrimaryBlue(VkXYColorEXT value)

Copies the specified VkXYColorEXT to the displayPrimaryBlue field.

public VkHdrMetadataEXT
displayPrimaryBlue(Consumer<VkXYColorEXT> consumer)

Passes the displayPrimaryBlue field to the specified Consumer.

public VkXYColorEXT
displayPrimaryGreen()

a VkXYColorEXT structure specifying the reference monitor’s green primary in chromaticity coordinates

public VkHdrMetadataEXT
displayPrimaryGreen(VkXYColorEXT value)

Copies the specified VkXYColorEXT to the displayPrimaryGreen field.

public VkHdrMetadataEXT
displayPrimaryGreen(Consumer<VkXYColorEXT> consumer)

Passes the displayPrimaryGreen field to the specified Consumer.

public VkXYColorEXT
displayPrimaryRed()

a VkXYColorEXT structure specifying the reference monitor’s red primary in chromaticity coordinates

public VkHdrMetadataEXT
displayPrimaryRed(VkXYColorEXT value)

Copies the specified VkXYColorEXT to the displayPrimaryRed field.

public VkHdrMetadataEXT
displayPrimaryRed(Consumer<VkXYColorEXT> consumer)

Passes the displayPrimaryRed field to the specified Consumer.

public static VkHdrMetadataEXT
malloc()

Returns a new VkHdrMetadataEXT instance allocated with memAlloc.

public static VkHdrMetadataEXT.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkHdrMetadataEXT.Buffer instance allocated with memAlloc.

public static VkHdrMetadataEXT
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkHdrMetadataEXT instance allocated on the specified MemoryStack.

public static VkHdrMetadataEXT.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static VkHdrMetadataEXT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkHdrMetadataEXT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkHdrMetadataEXT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkHdrMetadataEXT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public float
maxContentLightLevel()

content’s maximum luminance in nits

public VkHdrMetadataEXT
maxContentLightLevel(float value)

Sets the specified value to the maxContentLightLevel field.

public float
maxFrameAverageLightLevel()

the maximum frame average light level in nits

public VkHdrMetadataEXT
maxFrameAverageLightLevel(float value)

Sets the specified value to the maxFrameAverageLightLevel field.

public float
maxLuminance()

the maximum luminance of the reference monitor in nits

public VkHdrMetadataEXT
maxLuminance(float value)

Sets the specified value to the maxLuminance field.

public float
minLuminance()

the minimum luminance of the reference monitor in nits

public VkHdrMetadataEXT
minLuminance(float value)

Sets the specified value to the minLuminance field.

public static VkXYColorEXT
ndisplayPrimaryBlue(long struct)

Unsafe version of displayPrimaryBlue.

public static void
ndisplayPrimaryBlue(long struct, VkXYColorEXT value)

Unsafe version of displayPrimaryBlue.

public static VkXYColorEXT
ndisplayPrimaryGreen(long struct)

Unsafe version of displayPrimaryGreen.

public static void
ndisplayPrimaryGreen(long struct, VkXYColorEXT value)

Unsafe version of displayPrimaryGreen.

public static VkXYColorEXT
ndisplayPrimaryRed(long struct)

Unsafe version of displayPrimaryRed.

public static void
ndisplayPrimaryRed(long struct, VkXYColorEXT value)

Unsafe version of displayPrimaryRed.

public static float
nmaxContentLightLevel(long struct)

Unsafe version of maxContentLightLevel.

public static void
nmaxContentLightLevel(long struct, float value)

Unsafe version of maxContentLightLevel.

public static float
nmaxFrameAverageLightLevel(long struct)

Unsafe version of maxFrameAverageLightLevel.

public static void
nmaxFrameAverageLightLevel(long struct, float value)

Unsafe version of maxFrameAverageLightLevel.

public static float
nmaxLuminance(long struct)

Unsafe version of maxLuminance.

public static void
nmaxLuminance(long struct, float value)

Unsafe version of maxLuminance.

public static float
nminLuminance(long struct)

Unsafe version of minLuminance.

public static void
nminLuminance(long struct, float value)

Unsafe version of minLuminance.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static VkXYColorEXT
nwhitePoint(long struct)

Unsafe version of whitePoint.

public static void
nwhitePoint(long struct, VkXYColorEXT value)

Unsafe version of whitePoint.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkHdrMetadataEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkHdrMetadataEXT
set(int sType, long pNext, VkXYColorEXT displayPrimaryRed, VkXYColorEXT displayPrimaryGreen, VkXYColorEXT displayPrimaryBlue, VkXYColorEXT whitePoint, float maxLuminance, float minLuminance, float maxContentLightLevel, float maxFrameAverageLightLevel)

Initializes this struct with the specified values.

public VkHdrMetadataEXT

Returns:

this struct
set(VkHdrMetadataEXT
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkHdrMetadataEXT
sType(int value)

Sets the specified value to the sType field.

public VkHdrMetadataEXT
sType$Default()

Sets the STRUCTURE_TYPE_HDR_METADATA_EXT value to the sType field.

public VkXYColorEXT
whitePoint()

a VkXYColorEXT structure specifying the reference monitor’s white-point in chromaticity coordinates

public VkHdrMetadataEXT
whitePoint(VkXYColorEXT value)

Copies the specified VkXYColorEXT to the whitePoint field.

public VkHdrMetadataEXT
whitePoint(Consumer<VkXYColorEXT> consumer)

Passes the whitePoint field to the specified Consumer.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate