Package org.lwjgl.vulkan
Class VkHdrMetadataEXT
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkHdrMetadataEXT>
org.lwjgl.vulkan.VkHdrMetadataEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkHdrMetadataEXT
extends org.lwjgl.system.Struct<VkHdrMetadataEXT>
implements org.lwjgl.system.NativeResource
Specify HDR metadata.
Description
If any of the above values are unknown, they can be set to 0.
Note
The meta-data provided here is intended to be used as defined in the SMPTE 2086, CTA 861.3 and CIE 15:2004 specifications. The validity and use of this data is outside the scope of Vulkan.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_HDR_METADATA_EXTpNextmust beNULLor a pointer to a valid instance ofVkHdrVividDynamicMetadataHUAWEI- The
sTypevalue of each struct in thepNextchain must be unique
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 Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkHdrMetadataEXT(ByteBuffer container) Creates aVkHdrMetadataEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkHdrMetadataEXTcalloc()Returns a newVkHdrMetadataEXTinstance allocated withmemCalloc.static VkHdrMetadataEXT.Buffercalloc(int capacity) Returns a newVkHdrMetadataEXT.Bufferinstance allocated withmemCalloc.static VkHdrMetadataEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkHdrMetadataEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkHdrMetadataEXTcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkHdrMetadataEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkHdrMetadataEXTDeprecated.static VkHdrMetadataEXT.BuffercallocStack(int capacity) Deprecated.static VkHdrMetadataEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkHdrMetadataEXTcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkHdrMetadataEXTcreate()Returns a newVkHdrMetadataEXTinstance allocated withBufferUtils.static VkHdrMetadataEXT.Buffercreate(int capacity) Returns a newVkHdrMetadataEXT.Bufferinstance allocated withBufferUtils.static VkHdrMetadataEXTcreate(long address) Returns a newVkHdrMetadataEXTinstance for the specified memory address.static VkHdrMetadataEXT.Buffercreate(long address, int capacity) Create aVkHdrMetadataEXT.Bufferinstance at the specified memory.static @Nullable VkHdrMetadataEXTcreateSafe(long address) static @Nullable VkHdrMetadataEXT.BuffercreateSafe(long address, int capacity) aVkXYColorEXTstructure specifying the blue primary of the display used to optimize the contentdisplayPrimaryBlue(Consumer<VkXYColorEXT> consumer) Passes thedisplayPrimaryBlue()field to the specifiedConsumer.displayPrimaryBlue(VkXYColorEXT value) Copies the specifiedVkXYColorEXTto thedisplayPrimaryBlue()field.aVkXYColorEXTstructure specifying the green primary of the display used to optimize the contentdisplayPrimaryGreen(Consumer<VkXYColorEXT> consumer) Passes thedisplayPrimaryGreen()field to the specifiedConsumer.displayPrimaryGreen(VkXYColorEXT value) Copies the specifiedVkXYColorEXTto thedisplayPrimaryGreen()field.aVkXYColorEXTstructure specifying the red primary of the display used to optimize the contentdisplayPrimaryRed(Consumer<VkXYColorEXT> consumer) Passes thedisplayPrimaryRed()field to the specifiedConsumer.displayPrimaryRed(VkXYColorEXT value) Copies the specifiedVkXYColorEXTto thedisplayPrimaryRed()field.static VkHdrMetadataEXTmalloc()Returns a newVkHdrMetadataEXTinstance allocated withmemAlloc.static VkHdrMetadataEXT.Buffermalloc(int capacity) Returns a newVkHdrMetadataEXT.Bufferinstance allocated withmemAlloc.static VkHdrMetadataEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkHdrMetadataEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkHdrMetadataEXTmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkHdrMetadataEXTinstance allocated on the specifiedMemoryStack.static VkHdrMetadataEXTDeprecated.static VkHdrMetadataEXT.BuffermallocStack(int capacity) Deprecated.static VkHdrMetadataEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkHdrMetadataEXTmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.floatthe value in nits of the desired luminance for the brightest pixels in the displayed image.maxContentLightLevel(float value) Sets the specified value to themaxContentLightLevel()field.floatthe value in nits of the average luminance of the frame which has the brightest average luminance anywhere in the content.maxFrameAverageLightLevel(float value) Sets the specified value to themaxFrameAverageLightLevel()field.floatthe maximum luminance of the display used to optimize the content in nitsmaxLuminance(float value) Sets the specified value to themaxLuminance()field.floatthe minimum luminance of the display used to optimize the content in nitsminLuminance(float value) Sets the specified value to theminLuminance()field.static VkXYColorEXTndisplayPrimaryBlue(long struct) Unsafe version ofdisplayPrimaryBlue().static voidndisplayPrimaryBlue(long struct, VkXYColorEXT value) Unsafe version ofdisplayPrimaryBlue.static VkXYColorEXTndisplayPrimaryGreen(long struct) Unsafe version ofdisplayPrimaryGreen().static voidndisplayPrimaryGreen(long struct, VkXYColorEXT value) Unsafe version ofdisplayPrimaryGreen.static VkXYColorEXTndisplayPrimaryRed(long struct) Unsafe version ofdisplayPrimaryRed().static voidndisplayPrimaryRed(long struct, VkXYColorEXT value) Unsafe version ofdisplayPrimaryRed.static floatnmaxContentLightLevel(long struct) Unsafe version ofmaxContentLightLevel().static voidnmaxContentLightLevel(long struct, float value) Unsafe version ofmaxContentLightLevel.static floatnmaxFrameAverageLightLevel(long struct) Unsafe version ofmaxFrameAverageLightLevel().static voidnmaxFrameAverageLightLevel(long struct, float value) Unsafe version ofmaxFrameAverageLightLevel.static floatnmaxLuminance(long struct) Unsafe version ofmaxLuminance().static voidnmaxLuminance(long struct, float value) Unsafe version ofmaxLuminance.static floatnminLuminance(long struct) Unsafe version ofminLuminance().static voidnminLuminance(long struct, float value) Unsafe version ofminLuminance.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static VkXYColorEXTnwhitePoint(long struct) Unsafe version ofwhitePoint().static voidnwhitePoint(long struct, VkXYColorEXT value) Unsafe version ofwhitePoint.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkHdrVividDynamicMetadataHUAWEIvalue to thepNextchain.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(VkHdrMetadataEXT src) Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_HDR_METADATA_EXTvalue to thesType()field.aVkXYColorEXTstructure specifying the white-point of the display used to optimize the contentwhitePoint(Consumer<VkXYColorEXT> consumer) Passes thewhitePoint()field to the specifiedConsumer.whitePoint(VkXYColorEXT value) Copies the specifiedVkXYColorEXTto thewhitePoint()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
DISPLAYPRIMARYRED
public static final int DISPLAYPRIMARYREDThe struct member offsets. -
DISPLAYPRIMARYGREEN
public static final int DISPLAYPRIMARYGREENThe struct member offsets. -
DISPLAYPRIMARYBLUE
public static final int DISPLAYPRIMARYBLUEThe struct member offsets. -
WHITEPOINT
public static final int WHITEPOINTThe struct member offsets. -
MAXLUMINANCE
public static final int MAXLUMINANCEThe struct member offsets. -
MINLUMINANCE
public static final int MINLUMINANCEThe struct member offsets. -
MAXCONTENTLIGHTLEVEL
public static final int MAXCONTENTLIGHTLEVELThe struct member offsets. -
MAXFRAMEAVERAGELIGHTLEVEL
public static final int MAXFRAMEAVERAGELIGHTLEVELThe struct member offsets.
-
-
Constructor Details
-
VkHdrMetadataEXT
Creates aVkHdrMetadataEXTinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkHdrMetadataEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
displayPrimaryRed
aVkXYColorEXTstructure specifying the red primary of the display used to optimize the content -
displayPrimaryGreen
aVkXYColorEXTstructure specifying the green primary of the display used to optimize the content -
displayPrimaryBlue
aVkXYColorEXTstructure specifying the blue primary of the display used to optimize the content -
whitePoint
aVkXYColorEXTstructure specifying the white-point of the display used to optimize the content -
maxLuminance
public float maxLuminance()the maximum luminance of the display used to optimize the content in nits -
minLuminance
public float minLuminance()the minimum luminance of the display used to optimize the content in nits -
maxContentLightLevel
public float maxContentLightLevel()the value in nits of the desired luminance for the brightest pixels in the displayed image. -
maxFrameAverageLightLevel
public float maxFrameAverageLightLevel()the value in nits of the average luminance of the frame which has the brightest average luminance anywhere in the content. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_HDR_METADATA_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkHdrVividDynamicMetadataHUAWEIvalue to thepNextchain. -
displayPrimaryRed
Copies the specifiedVkXYColorEXTto thedisplayPrimaryRed()field. -
displayPrimaryRed
Passes thedisplayPrimaryRed()field to the specifiedConsumer. -
displayPrimaryGreen
Copies the specifiedVkXYColorEXTto thedisplayPrimaryGreen()field. -
displayPrimaryGreen
Passes thedisplayPrimaryGreen()field to the specifiedConsumer. -
displayPrimaryBlue
Copies the specifiedVkXYColorEXTto thedisplayPrimaryBlue()field. -
displayPrimaryBlue
Passes thedisplayPrimaryBlue()field to the specifiedConsumer. -
whitePoint
Copies the specifiedVkXYColorEXTto thewhitePoint()field. -
whitePoint
Passes thewhitePoint()field to the specifiedConsumer. -
maxLuminance
Sets the specified value to themaxLuminance()field. -
minLuminance
Sets the specified value to theminLuminance()field. -
maxContentLightLevel
Sets the specified value to themaxContentLightLevel()field. -
maxFrameAverageLightLevel
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
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkHdrMetadataEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkHdrMetadataEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkHdrMetadataEXTinstance allocated withBufferUtils. -
create
Returns a newVkHdrMetadataEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkHdrMetadataEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkHdrMetadataEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkHdrMetadataEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkHdrMetadataEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkHdrMetadataEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkHdrMetadataEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkHdrMetadataEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkHdrMetadataEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
Returns a newVkHdrMetadataEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
Returns a newVkHdrMetadataEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
ndisplayPrimaryRed
Unsafe version ofdisplayPrimaryRed(). -
ndisplayPrimaryGreen
Unsafe version ofdisplayPrimaryGreen(). -
ndisplayPrimaryBlue
Unsafe version ofdisplayPrimaryBlue(). -
nwhitePoint
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
Unsafe version ofdisplayPrimaryRed. -
ndisplayPrimaryGreen
Unsafe version ofdisplayPrimaryGreen. -
ndisplayPrimaryBlue
Unsafe version ofdisplayPrimaryBlue. -
nwhitePoint
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.
-