org.lwjgl.vulkan.VkHdrMetadataEXT Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* structure to specify Hdr metadata.
*
* Description
*
* note
*
* The validity and use of this data is outside the scope of Vulkan and thus no +Valid Usage+ is given.
*
*
* See Also
*
* {@link VkXYColorEXT}, {@link EXTHdrMetadata#vkSetHdrMetadataEXT SetHdrMetadataEXT}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code displayPrimaryRed} – the mastering display’s red primary in chromaticity coordinates
* - {@code displayPrimaryGreen} – the mastering display’s green primary in chromaticity coordinates
* - {@code displayPrimaryBlue} – the mastering display’s blue primary in chromaticity coordinates
* - {@code whitePoint} – the mastering display’s white-point in chromaticity coordinates
* - {@code maxLuminance} – the maximum luminance of the mastering display in nits
* - {@code minLuminance} – the minimum luminance of the mastering display in nits
* - {@code maxContentLightLevel} – content’s maximum luminance in nits
* - {@code maxFrameAverageLightLevel} – the maximum frame average light level in nits
*
*
* Layout
*
*
* struct VkHdrMetadataEXT {
* VkStructureType sType;
* const void * pNext;
* {@link VkXYColorEXT VkXYColorEXT} displayPrimaryRed;
* {@link VkXYColorEXT VkXYColorEXT} displayPrimaryGreen;
* {@link VkXYColorEXT VkXYColorEXT} displayPrimaryBlue;
* {@link VkXYColorEXT VkXYColorEXT} whitePoint;
* float maxLuminance;
* float minLuminance;
* float maxContentLightLevel;
* float maxFrameAverageLightLevel;
* }The created instance holds a strong reference to the container object.
*/
public VkHdrMetadataEXT(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return npNext(address()); }
/** Returns a {@link VkXYColorEXT} view of the {@code displayPrimaryRed} field. */
public VkXYColorEXT displayPrimaryRed() { return ndisplayPrimaryRed(address()); }
/** Returns a {@link VkXYColorEXT} view of the {@code displayPrimaryGreen} field. */
public VkXYColorEXT displayPrimaryGreen() { return ndisplayPrimaryGreen(address()); }
/** Returns a {@link VkXYColorEXT} view of the {@code displayPrimaryBlue} field. */
public VkXYColorEXT displayPrimaryBlue() { return ndisplayPrimaryBlue(address()); }
/** Returns a {@link VkXYColorEXT} view of the {@code whitePoint} field. */
public VkXYColorEXT whitePoint() { return nwhitePoint(address()); }
/** Returns the value of the {@code maxLuminance} field. */
public float maxLuminance() { return nmaxLuminance(address()); }
/** Returns the value of the {@code minLuminance} field. */
public float minLuminance() { return nminLuminance(address()); }
/** Returns the value of the {@code maxContentLightLevel} field. */
public float maxContentLightLevel() { return nmaxContentLightLevel(address()); }
/** Returns the value of the {@code maxFrameAverageLightLevel} field. */
public float maxFrameAverageLightLevel() { return nmaxFrameAverageLightLevel(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkHdrMetadataEXT sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkHdrMetadataEXT pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Copies the specified {@link VkXYColorEXT} to the {@code displayPrimaryRed} field. */
public VkHdrMetadataEXT displayPrimaryRed(VkXYColorEXT value) { ndisplayPrimaryRed(address(), value); return this; }
/** Copies the specified {@link VkXYColorEXT} to the {@code displayPrimaryGreen} field. */
public VkHdrMetadataEXT displayPrimaryGreen(VkXYColorEXT value) { ndisplayPrimaryGreen(address(), value); return this; }
/** Copies the specified {@link VkXYColorEXT} to the {@code displayPrimaryBlue} field. */
public VkHdrMetadataEXT displayPrimaryBlue(VkXYColorEXT value) { ndisplayPrimaryBlue(address(), value); return this; }
/** Copies the specified {@link VkXYColorEXT} to the {@code whitePoint} field. */
public VkHdrMetadataEXT whitePoint(VkXYColorEXT value) { nwhitePoint(address(), value); return this; }
/** Sets the specified value to the {@code maxLuminance} field. */
public VkHdrMetadataEXT maxLuminance(float value) { nmaxLuminance(address(), value); return this; }
/** Sets the specified value to the {@code minLuminance} field. */
public VkHdrMetadataEXT minLuminance(float value) { nminLuminance(address(), value); return this; }
/** Sets the specified value to the {@code maxContentLightLevel} field. */
public VkHdrMetadataEXT maxContentLightLevel(float value) { nmaxContentLightLevel(address(), value); return this; }
/** Sets the specified value to the {@code maxFrameAverageLightLevel} field. */
public VkHdrMetadataEXT maxFrameAverageLightLevel(float value) { nmaxFrameAverageLightLevel(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkHdrMetadataEXT set(
int sType,
long pNext,
VkXYColorEXT displayPrimaryRed,
VkXYColorEXT displayPrimaryGreen,
VkXYColorEXT displayPrimaryBlue,
VkXYColorEXT whitePoint,
float maxLuminance,
float minLuminance,
float maxContentLightLevel,
float maxFrameAverageLightLevel
) {
sType(sType);
pNext(pNext);
displayPrimaryRed(displayPrimaryRed);
displayPrimaryGreen(displayPrimaryGreen);
displayPrimaryBlue(displayPrimaryBlue);
whitePoint(whitePoint);
maxLuminance(maxLuminance);
minLuminance(minLuminance);
maxContentLightLevel(maxContentLightLevel);
maxFrameAverageLightLevel(maxFrameAverageLightLevel);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkHdrMetadataEXT set(VkHdrMetadataEXT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkHdrMetadataEXT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkHdrMetadataEXT malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkHdrMetadataEXT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkHdrMetadataEXT calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkHdrMetadataEXT} instance allocated with {@link BufferUtils}. */
public static VkHdrMetadataEXT create() {
return new VkHdrMetadataEXT(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkHdrMetadataEXT} instance for the specified memory address. */
public static VkHdrMetadataEXT create(long address) {
return new VkHdrMetadataEXT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkHdrMetadataEXT createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkHdrMetadataEXT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkHdrMetadataEXT.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkHdrMetadataEXT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkHdrMetadataEXT.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkHdrMetadataEXT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkHdrMetadataEXT.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkHdrMetadataEXT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkHdrMetadataEXT.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkHdrMetadataEXT.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkHdrMetadataEXT} instance allocated on the thread-local {@link MemoryStack}. */
public static VkHdrMetadataEXT mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkHdrMetadataEXT} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkHdrMetadataEXT callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkHdrMetadataEXT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkHdrMetadataEXT mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkHdrMetadataEXT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkHdrMetadataEXT callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkHdrMetadataEXT.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkHdrMetadataEXT.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkHdrMetadataEXT.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkHdrMetadataEXT.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkHdrMetadataEXT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkHdrMetadataEXT.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkHdrMetadataEXT.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkHdrMetadataEXT.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkHdrMetadataEXT.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkHdrMetadataEXT.PNEXT); }
/** Unsafe version of {@link #displayPrimaryRed}. */
public static VkXYColorEXT ndisplayPrimaryRed(long struct) { return VkXYColorEXT.create(struct + VkHdrMetadataEXT.DISPLAYPRIMARYRED); }
/** Unsafe version of {@link #displayPrimaryGreen}. */
public static VkXYColorEXT ndisplayPrimaryGreen(long struct) { return VkXYColorEXT.create(struct + VkHdrMetadataEXT.DISPLAYPRIMARYGREEN); }
/** Unsafe version of {@link #displayPrimaryBlue}. */
public static VkXYColorEXT ndisplayPrimaryBlue(long struct) { return VkXYColorEXT.create(struct + VkHdrMetadataEXT.DISPLAYPRIMARYBLUE); }
/** Unsafe version of {@link #whitePoint}. */
public static VkXYColorEXT nwhitePoint(long struct) { return VkXYColorEXT.create(struct + VkHdrMetadataEXT.WHITEPOINT); }
/** Unsafe version of {@link #maxLuminance}. */
public static float nmaxLuminance(long struct) { return memGetFloat(struct + VkHdrMetadataEXT.MAXLUMINANCE); }
/** Unsafe version of {@link #minLuminance}. */
public static float nminLuminance(long struct) { return memGetFloat(struct + VkHdrMetadataEXT.MINLUMINANCE); }
/** Unsafe version of {@link #maxContentLightLevel}. */
public static float nmaxContentLightLevel(long struct) { return memGetFloat(struct + VkHdrMetadataEXT.MAXCONTENTLIGHTLEVEL); }
/** Unsafe version of {@link #maxFrameAverageLightLevel}. */
public static float nmaxFrameAverageLightLevel(long struct) { return memGetFloat(struct + VkHdrMetadataEXT.MAXFRAMEAVERAGELIGHTLEVEL); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkHdrMetadataEXT.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkHdrMetadataEXT.PNEXT, value); }
/** Unsafe version of {@link #displayPrimaryRed(VkXYColorEXT) displayPrimaryRed}. */
public static void ndisplayPrimaryRed(long struct, VkXYColorEXT value) { memCopy(value.address(), struct + VkHdrMetadataEXT.DISPLAYPRIMARYRED, VkXYColorEXT.SIZEOF); }
/** Unsafe version of {@link #displayPrimaryGreen(VkXYColorEXT) displayPrimaryGreen}. */
public static void ndisplayPrimaryGreen(long struct, VkXYColorEXT value) { memCopy(value.address(), struct + VkHdrMetadataEXT.DISPLAYPRIMARYGREEN, VkXYColorEXT.SIZEOF); }
/** Unsafe version of {@link #displayPrimaryBlue(VkXYColorEXT) displayPrimaryBlue}. */
public static void ndisplayPrimaryBlue(long struct, VkXYColorEXT value) { memCopy(value.address(), struct + VkHdrMetadataEXT.DISPLAYPRIMARYBLUE, VkXYColorEXT.SIZEOF); }
/** Unsafe version of {@link #whitePoint(VkXYColorEXT) whitePoint}. */
public static void nwhitePoint(long struct, VkXYColorEXT value) { memCopy(value.address(), struct + VkHdrMetadataEXT.WHITEPOINT, VkXYColorEXT.SIZEOF); }
/** Unsafe version of {@link #maxLuminance(float) maxLuminance}. */
public static void nmaxLuminance(long struct, float value) { memPutFloat(struct + VkHdrMetadataEXT.MAXLUMINANCE, value); }
/** Unsafe version of {@link #minLuminance(float) minLuminance}. */
public static void nminLuminance(long struct, float value) { memPutFloat(struct + VkHdrMetadataEXT.MINLUMINANCE, value); }
/** Unsafe version of {@link #maxContentLightLevel(float) maxContentLightLevel}. */
public static void nmaxContentLightLevel(long struct, float value) { memPutFloat(struct + VkHdrMetadataEXT.MAXCONTENTLIGHTLEVEL, value); }
/** Unsafe version of {@link #maxFrameAverageLightLevel(float) maxFrameAverageLightLevel}. */
public static void nmaxFrameAverageLightLevel(long struct, float value) { memPutFloat(struct + VkHdrMetadataEXT.MAXFRAMEAVERAGELIGHTLEVEL, value); }
// -----------------------------------
/** An array of {@link VkHdrMetadataEXT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkHdrMetadataEXT.Buffer} instance backed by the specified container.
*
* Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
* will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
* by {@link VkHdrMetadataEXT#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkHdrMetadataEXT newInstance(long address) {
return new VkHdrMetadataEXT(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkHdrMetadataEXT.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkHdrMetadataEXT.npNext(address()); }
/** Returns a {@link VkXYColorEXT} view of the {@code displayPrimaryRed} field. */
public VkXYColorEXT displayPrimaryRed() { return VkHdrMetadataEXT.ndisplayPrimaryRed(address()); }
/** Returns a {@link VkXYColorEXT} view of the {@code displayPrimaryGreen} field. */
public VkXYColorEXT displayPrimaryGreen() { return VkHdrMetadataEXT.ndisplayPrimaryGreen(address()); }
/** Returns a {@link VkXYColorEXT} view of the {@code displayPrimaryBlue} field. */
public VkXYColorEXT displayPrimaryBlue() { return VkHdrMetadataEXT.ndisplayPrimaryBlue(address()); }
/** Returns a {@link VkXYColorEXT} view of the {@code whitePoint} field. */
public VkXYColorEXT whitePoint() { return VkHdrMetadataEXT.nwhitePoint(address()); }
/** Returns the value of the {@code maxLuminance} field. */
public float maxLuminance() { return VkHdrMetadataEXT.nmaxLuminance(address()); }
/** Returns the value of the {@code minLuminance} field. */
public float minLuminance() { return VkHdrMetadataEXT.nminLuminance(address()); }
/** Returns the value of the {@code maxContentLightLevel} field. */
public float maxContentLightLevel() { return VkHdrMetadataEXT.nmaxContentLightLevel(address()); }
/** Returns the value of the {@code maxFrameAverageLightLevel} field. */
public float maxFrameAverageLightLevel() { return VkHdrMetadataEXT.nmaxFrameAverageLightLevel(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkHdrMetadataEXT.Buffer sType(@NativeType("VkStructureType") int value) { VkHdrMetadataEXT.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkHdrMetadataEXT.Buffer pNext(@NativeType("const void *") long value) { VkHdrMetadataEXT.npNext(address(), value); return this; }
/** Copies the specified {@link VkXYColorEXT} to the {@code displayPrimaryRed} field. */
public VkHdrMetadataEXT.Buffer displayPrimaryRed(VkXYColorEXT value) { VkHdrMetadataEXT.ndisplayPrimaryRed(address(), value); return this; }
/** Copies the specified {@link VkXYColorEXT} to the {@code displayPrimaryGreen} field. */
public VkHdrMetadataEXT.Buffer displayPrimaryGreen(VkXYColorEXT value) { VkHdrMetadataEXT.ndisplayPrimaryGreen(address(), value); return this; }
/** Copies the specified {@link VkXYColorEXT} to the {@code displayPrimaryBlue} field. */
public VkHdrMetadataEXT.Buffer displayPrimaryBlue(VkXYColorEXT value) { VkHdrMetadataEXT.ndisplayPrimaryBlue(address(), value); return this; }
/** Copies the specified {@link VkXYColorEXT} to the {@code whitePoint} field. */
public VkHdrMetadataEXT.Buffer whitePoint(VkXYColorEXT value) { VkHdrMetadataEXT.nwhitePoint(address(), value); return this; }
/** Sets the specified value to the {@code maxLuminance} field. */
public VkHdrMetadataEXT.Buffer maxLuminance(float value) { VkHdrMetadataEXT.nmaxLuminance(address(), value); return this; }
/** Sets the specified value to the {@code minLuminance} field. */
public VkHdrMetadataEXT.Buffer minLuminance(float value) { VkHdrMetadataEXT.nminLuminance(address(), value); return this; }
/** Sets the specified value to the {@code maxContentLightLevel} field. */
public VkHdrMetadataEXT.Buffer maxContentLightLevel(float value) { VkHdrMetadataEXT.nmaxContentLightLevel(address(), value); return this; }
/** Sets the specified value to the {@code maxFrameAverageLightLevel} field. */
public VkHdrMetadataEXT.Buffer maxFrameAverageLightLevel(float value) { VkHdrMetadataEXT.nmaxFrameAverageLightLevel(address(), value); return this; }
}
}