Package org.lwjgl.vulkan
Class VkHdrMetadataEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkHdrMetadataEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkHdrMetadataEXT extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
structure to specify Hdr metadata.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_HDR_METADATA_EXT
pNext
must beNULL
Note
The validity and use of this data is outside the scope of Vulkan.
See Also
VkXYColorEXT
,SetHdrMetadataEXT
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.displayPrimaryRed
– the mastering display’s red primary in chromaticity coordinatesdisplayPrimaryGreen
– the mastering display’s green primary in chromaticity coordinatesdisplayPrimaryBlue
– the mastering display’s blue primary in chromaticity coordinateswhitePoint
– the mastering display’s white-point in chromaticity coordinatesmaxLuminance
– the maximum luminance of the mastering display in nitsminLuminance
– the minimum luminance of the mastering display in nitsmaxContentLightLevel
– content’s maximum luminance in nitsmaxFrameAverageLightLevel
– the maximum frame average light level in nits
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 Class Summary
Nested Classes Modifier and Type Class Description static class
VkHdrMetadataEXT.Buffer
An array ofVkHdrMetadataEXT
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
DISPLAYPRIMARYBLUE
DISPLAYPRIMARYGREEN
DISPLAYPRIMARYRED
MAXCONTENTLIGHTLEVEL
MAXFRAMEAVERAGELIGHTLEVEL
MAXLUMINANCE
MINLUMINANCE
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
WHITEPOINTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkHdrMetadataEXT(java.nio.ByteBuffer container)
Creates aVkHdrMetadataEXT
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkHdrMetadataEXT
calloc()
Returns a newVkHdrMetadataEXT
instance allocated withmemCalloc
.static VkHdrMetadataEXT.Buffer
calloc(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated withmemCalloc
.static VkHdrMetadataEXT
callocStack()
Returns a newVkHdrMetadataEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkHdrMetadataEXT.Buffer
callocStack(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkHdrMetadataEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkHdrMetadataEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkHdrMetadataEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkHdrMetadataEXT
create()
Returns a newVkHdrMetadataEXT
instance allocated withBufferUtils
.static VkHdrMetadataEXT.Buffer
create(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated withBufferUtils
.static VkHdrMetadataEXT
create(long address)
Returns a newVkHdrMetadataEXT
instance for the specified memory address.static VkHdrMetadataEXT.Buffer
create(long address, int capacity)
Create aVkHdrMetadataEXT.Buffer
instance at the specified memory.static VkHdrMetadataEXT
createSafe(long address)
static VkHdrMetadataEXT.Buffer
createSafe(long address, int capacity)
VkXYColorEXT
displayPrimaryBlue()
Returns aVkXYColorEXT
view of thedisplayPrimaryBlue
field.VkHdrMetadataEXT
displayPrimaryBlue(java.util.function.Consumer<VkXYColorEXT> consumer)
Passes thedisplayPrimaryBlue
field to the specifiedConsumer
.VkHdrMetadataEXT
displayPrimaryBlue(VkXYColorEXT value)
Copies the specifiedVkXYColorEXT
to thedisplayPrimaryBlue
field.VkXYColorEXT
displayPrimaryGreen()
Returns aVkXYColorEXT
view of thedisplayPrimaryGreen
field.VkHdrMetadataEXT
displayPrimaryGreen(java.util.function.Consumer<VkXYColorEXT> consumer)
Passes thedisplayPrimaryGreen
field to the specifiedConsumer
.VkHdrMetadataEXT
displayPrimaryGreen(VkXYColorEXT value)
Copies the specifiedVkXYColorEXT
to thedisplayPrimaryGreen
field.VkXYColorEXT
displayPrimaryRed()
Returns aVkXYColorEXT
view of thedisplayPrimaryRed
field.VkHdrMetadataEXT
displayPrimaryRed(java.util.function.Consumer<VkXYColorEXT> consumer)
Passes thedisplayPrimaryRed
field to the specifiedConsumer
.VkHdrMetadataEXT
displayPrimaryRed(VkXYColorEXT value)
Copies the specifiedVkXYColorEXT
to thedisplayPrimaryRed
field.static VkHdrMetadataEXT
malloc()
Returns a newVkHdrMetadataEXT
instance allocated withmemAlloc
.static VkHdrMetadataEXT.Buffer
malloc(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated withmemAlloc
.static VkHdrMetadataEXT
mallocStack()
Returns a newVkHdrMetadataEXT
instance allocated on the thread-localMemoryStack
.static VkHdrMetadataEXT.Buffer
mallocStack(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkHdrMetadataEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkHdrMetadataEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkHdrMetadataEXT
instance allocated on the specifiedMemoryStack
.float
maxContentLightLevel()
Returns the value of themaxContentLightLevel
field.VkHdrMetadataEXT
maxContentLightLevel(float value)
Sets the specified value to themaxContentLightLevel
field.float
maxFrameAverageLightLevel()
Returns the value of themaxFrameAverageLightLevel
field.VkHdrMetadataEXT
maxFrameAverageLightLevel(float value)
Sets the specified value to themaxFrameAverageLightLevel
field.float
maxLuminance()
Returns the value of themaxLuminance
field.VkHdrMetadataEXT
maxLuminance(float value)
Sets the specified value to themaxLuminance
field.float
minLuminance()
Returns the value of theminLuminance
field.VkHdrMetadataEXT
minLuminance(float value)
Sets the specified value to theminLuminance
field.static VkXYColorEXT
ndisplayPrimaryBlue(long struct)
Unsafe version ofdisplayPrimaryBlue()
.static void
ndisplayPrimaryBlue(long struct, VkXYColorEXT value)
Unsafe version ofdisplayPrimaryBlue
.static VkXYColorEXT
ndisplayPrimaryGreen(long struct)
Unsafe version ofdisplayPrimaryGreen()
.static void
ndisplayPrimaryGreen(long struct, VkXYColorEXT value)
Unsafe version ofdisplayPrimaryGreen
.static VkXYColorEXT
ndisplayPrimaryRed(long struct)
Unsafe version ofdisplayPrimaryRed()
.static void
ndisplayPrimaryRed(long struct, VkXYColorEXT value)
Unsafe version ofdisplayPrimaryRed
.static float
nmaxContentLightLevel(long struct)
Unsafe version ofmaxContentLightLevel()
.static void
nmaxContentLightLevel(long struct, float value)
Unsafe version ofmaxContentLightLevel
.static float
nmaxFrameAverageLightLevel(long struct)
Unsafe version ofmaxFrameAverageLightLevel()
.static void
nmaxFrameAverageLightLevel(long struct, float value)
Unsafe version ofmaxFrameAverageLightLevel
.static float
nmaxLuminance(long struct)
Unsafe version ofmaxLuminance()
.static void
nmaxLuminance(long struct, float value)
Unsafe version ofmaxLuminance
.static float
nminLuminance(long struct)
Unsafe version ofminLuminance()
.static void
nminLuminance(long struct, float value)
Unsafe version ofminLuminance
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static VkXYColorEXT
nwhitePoint(long struct)
Unsafe version ofwhitePoint()
.static void
nwhitePoint(long struct, VkXYColorEXT value)
Unsafe version ofwhitePoint
.long
pNext()
Returns the value of thepNext
field.VkHdrMetadataEXT
pNext(long value)
Sets the specified value to thepNext
field.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.VkHdrMetadataEXT
set(VkHdrMetadataEXT src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkHdrMetadataEXT
sType(int value)
Sets the specified value to thesType
field.VkXYColorEXT
whitePoint()
Returns aVkXYColorEXT
view of thewhitePoint
field.VkHdrMetadataEXT
whitePoint(java.util.function.Consumer<VkXYColorEXT> consumer)
Passes thewhitePoint
field to the specifiedConsumer
.VkHdrMetadataEXT
whitePoint(VkXYColorEXT value)
Copies the specifiedVkXYColorEXT
to thewhitePoint
field.
-
-
-
Constructor Detail
-
VkHdrMetadataEXT
public VkHdrMetadataEXT(java.nio.ByteBuffer container)
Creates aVkHdrMetadataEXT
instance at the current position of the specifiedByteBuffer
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
displayPrimaryRed
public VkXYColorEXT displayPrimaryRed()
Returns aVkXYColorEXT
view of thedisplayPrimaryRed
field.
-
displayPrimaryGreen
public VkXYColorEXT displayPrimaryGreen()
Returns aVkXYColorEXT
view of thedisplayPrimaryGreen
field.
-
displayPrimaryBlue
public VkXYColorEXT displayPrimaryBlue()
Returns aVkXYColorEXT
view of thedisplayPrimaryBlue
field.
-
whitePoint
public VkXYColorEXT whitePoint()
Returns aVkXYColorEXT
view of thewhitePoint
field.
-
maxLuminance
public float maxLuminance()
Returns the value of themaxLuminance
field.
-
minLuminance
public float minLuminance()
Returns the value of theminLuminance
field.
-
maxContentLightLevel
public float maxContentLightLevel()
Returns the value of themaxContentLightLevel
field.
-
maxFrameAverageLightLevel
public float maxFrameAverageLightLevel()
Returns the value of themaxFrameAverageLightLevel
field.
-
sType
public VkHdrMetadataEXT sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkHdrMetadataEXT pNext(long value)
Sets the specified value to thepNext
field.
-
displayPrimaryRed
public VkHdrMetadataEXT displayPrimaryRed(VkXYColorEXT value)
Copies the specifiedVkXYColorEXT
to thedisplayPrimaryRed
field.
-
displayPrimaryRed
public VkHdrMetadataEXT displayPrimaryRed(java.util.function.Consumer<VkXYColorEXT> consumer)
Passes thedisplayPrimaryRed
field to the specifiedConsumer
.
-
displayPrimaryGreen
public VkHdrMetadataEXT displayPrimaryGreen(VkXYColorEXT value)
Copies the specifiedVkXYColorEXT
to thedisplayPrimaryGreen
field.
-
displayPrimaryGreen
public VkHdrMetadataEXT displayPrimaryGreen(java.util.function.Consumer<VkXYColorEXT> consumer)
Passes thedisplayPrimaryGreen
field to the specifiedConsumer
.
-
displayPrimaryBlue
public VkHdrMetadataEXT displayPrimaryBlue(VkXYColorEXT value)
Copies the specifiedVkXYColorEXT
to thedisplayPrimaryBlue
field.
-
displayPrimaryBlue
public VkHdrMetadataEXT displayPrimaryBlue(java.util.function.Consumer<VkXYColorEXT> consumer)
Passes thedisplayPrimaryBlue
field to the specifiedConsumer
.
-
whitePoint
public VkHdrMetadataEXT whitePoint(VkXYColorEXT value)
Copies the specifiedVkXYColorEXT
to thewhitePoint
field.
-
whitePoint
public VkHdrMetadataEXT whitePoint(java.util.function.Consumer<VkXYColorEXT> consumer)
Passes thewhitePoint
field to the specifiedConsumer
.
-
maxLuminance
public VkHdrMetadataEXT maxLuminance(float value)
Sets the specified value to themaxLuminance
field.
-
minLuminance
public VkHdrMetadataEXT minLuminance(float value)
Sets the specified value to theminLuminance
field.
-
maxContentLightLevel
public VkHdrMetadataEXT maxContentLightLevel(float value)
Sets the specified value to themaxContentLightLevel
field.
-
maxFrameAverageLightLevel
public VkHdrMetadataEXT maxFrameAverageLightLevel(float value)
Sets the specified value to themaxFrameAverageLightLevel
field.
-
set
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.
-
set
public VkHdrMetadataEXT set(VkHdrMetadataEXT src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkHdrMetadataEXT malloc()
Returns a newVkHdrMetadataEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkHdrMetadataEXT calloc()
Returns a newVkHdrMetadataEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkHdrMetadataEXT create()
Returns a newVkHdrMetadataEXT
instance allocated withBufferUtils
.
-
create
public static VkHdrMetadataEXT create(long address)
Returns a newVkHdrMetadataEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkHdrMetadataEXT createSafe(long address)
-
malloc
public static VkHdrMetadataEXT.Buffer malloc(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkHdrMetadataEXT.Buffer calloc(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkHdrMetadataEXT.Buffer create(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkHdrMetadataEXT.Buffer create(long address, int capacity)
Create aVkHdrMetadataEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkHdrMetadataEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkHdrMetadataEXT mallocStack()
Returns a newVkHdrMetadataEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkHdrMetadataEXT callocStack()
Returns a newVkHdrMetadataEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkHdrMetadataEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkHdrMetadataEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkHdrMetadataEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkHdrMetadataEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkHdrMetadataEXT.Buffer mallocStack(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkHdrMetadataEXT.Buffer callocStack(int capacity)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkHdrMetadataEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkHdrMetadataEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkHdrMetadataEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
ndisplayPrimaryRed
public static VkXYColorEXT ndisplayPrimaryRed(long struct)
Unsafe version ofdisplayPrimaryRed()
.
-
ndisplayPrimaryGreen
public static VkXYColorEXT ndisplayPrimaryGreen(long struct)
Unsafe version ofdisplayPrimaryGreen()
.
-
ndisplayPrimaryBlue
public static VkXYColorEXT ndisplayPrimaryBlue(long struct)
Unsafe version ofdisplayPrimaryBlue()
.
-
nwhitePoint
public static VkXYColorEXT nwhitePoint(long struct)
Unsafe version ofwhitePoint()
.
-
nmaxLuminance
public static float nmaxLuminance(long struct)
Unsafe version ofmaxLuminance()
.
-
nminLuminance
public static float nminLuminance(long struct)
Unsafe version ofminLuminance()
.
-
nmaxContentLightLevel
public static float nmaxContentLightLevel(long struct)
Unsafe version ofmaxContentLightLevel()
.
-
nmaxFrameAverageLightLevel
public static float nmaxFrameAverageLightLevel(long struct)
Unsafe version ofmaxFrameAverageLightLevel()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
ndisplayPrimaryRed
public static void ndisplayPrimaryRed(long struct, VkXYColorEXT value)
Unsafe version ofdisplayPrimaryRed
.
-
ndisplayPrimaryGreen
public static void ndisplayPrimaryGreen(long struct, VkXYColorEXT value)
Unsafe version ofdisplayPrimaryGreen
.
-
ndisplayPrimaryBlue
public static void ndisplayPrimaryBlue(long struct, VkXYColorEXT value)
Unsafe version ofdisplayPrimaryBlue
.
-
nwhitePoint
public static void nwhitePoint(long struct, VkXYColorEXT value)
Unsafe version ofwhitePoint
.
-
nmaxLuminance
public static void nmaxLuminance(long struct, float value)
Unsafe version ofmaxLuminance
.
-
nminLuminance
public static void nminLuminance(long struct, float value)
Unsafe version ofminLuminance
.
-
nmaxContentLightLevel
public static void nmaxContentLightLevel(long struct, float value)
Unsafe version ofmaxContentLightLevel
.
-
nmaxFrameAverageLightLevel
public static void nmaxFrameAverageLightLevel(long struct, float value)
Unsafe version ofmaxFrameAverageLightLevel
.
-
-