org.lwjgl.vulkan.VkPipelineCoverageModulationStateCreateInfoNV 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 specifying parameters controlling coverage modulation.
*
* Description
*
* If {@code coverageModulationTableEnable} is {@link VK10#VK_FALSE FALSE}, then for each color sample the associated bits of the fragment's coverage are counted and divided by the number of associated bits to produce a modulation factor R in the range (0,1] (a value of zero would have been killed due to a color coverage of 0). Specifically:
*
*
* N = value of {@code rasterizationSamples}M = value of {@link VkAttachmentDescription}{@code ::samples} for any color attachmentsR = popcount(associated coverage bits) / (N / M)
*
* If {@code coverageModulationTableEnable} is {@link VK10#VK_TRUE TRUE}, the value R is computed using a programmable lookup table. The lookup table has N / M elements, and the element of the table is selected by:
*
*
* R = pCoverageModulationTable[popcount(associated coverage bits)-1]
*
* Note that the table does not have an entry for popcount(associated coverage bits) = 0, because such samples would have been killed.
*
* The values of {@code pCoverageModulationTable} may be rounded to an implementation-dependent precision, which is at least as fine as 1 / N, and clamped to [0,1].
*
* For each color attachment with a floating point or normalized color format, each fragment output color value is replicated to M values which can each be modulated (multiplied) by that color sample's associated value of R. Which components are modulated is controlled by {@code coverageModulationMode}.
*
* If this structure is not present, it is as if coverageModulationMode is {@link NVFramebufferMixedSamples#VK_COVERAGE_MODULATION_MODE_NONE_NV COVERAGE_MODULATION_MODE_NONE_NV}.
*
* Valid Usage
*
*
* - If {@code coverageModulationTableEnable} is {@link VK10#VK_TRUE TRUE}, {@code coverageModulationTableCount} must be equal to the number of rasterization samples divided by the number of color samples in the subpass.
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link NVFramebufferMixedSamples#VK_STRUCTURE_TYPE_PIPELINE_COVERAGE_MODULATION_STATE_CREATE_INFO_NV STRUCTURE_TYPE_PIPELINE_COVERAGE_MODULATION_STATE_CREATE_INFO_NV}
* - {@code pNext} must be {@code NULL}
* - {@code flags} must be 0
* - {@code coverageModulationMode} must be a valid {@code VkCoverageModulationModeNV} value
* - {@code coverageModulationTableCount} must be greater than 0
*
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code flags} – reserved for future use.
* - {@code coverageModulationMode} – controls which color components are modulated and is of type {@code VkCoverageModulationModeNV}.
* - {@code coverageModulationTableEnable} – controls whether the modulation factor is looked up from a table in {@code pCoverageModulationTable}.
* - {@code coverageModulationTableCount} – the number of elements in {@code pCoverageModulationTable}.
* - {@code pCoverageModulationTable} – a table of modulation factors containing a value for each number of covered samples.
*
*
* Layout
*
*
* struct VkPipelineCoverageModulationStateCreateInfoNV {
* VkStructureType sType;
* const void * pNext;
* VkPipelineCoverageModulationStateCreateFlagsNV flags;
* VkCoverageModulationModeNV coverageModulationMode;
* VkBool32 coverageModulationTableEnable;
* uint32_t coverageModulationTableCount;
* const float * pCoverageModulationTable;
* }The created instance holds a strong reference to the container object.
*/
public VkPipelineCoverageModulationStateCreateInfoNV(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 the value of the {@code flags} field. */
@NativeType("VkPipelineCoverageModulationStateCreateFlagsNV")
public int flags() { return nflags(address()); }
/** Returns the value of the {@code coverageModulationMode} field. */
@NativeType("VkCoverageModulationModeNV")
public int coverageModulationMode() { return ncoverageModulationMode(address()); }
/** Returns the value of the {@code coverageModulationTableEnable} field. */
@NativeType("VkBool32")
public boolean coverageModulationTableEnable() { return ncoverageModulationTableEnable(address()) != 0; }
/** Returns the value of the {@code coverageModulationTableCount} field. */
@NativeType("uint32_t")
public int coverageModulationTableCount() { return ncoverageModulationTableCount(address()); }
/** Returns a {@link FloatBuffer} view of the data pointed to by the {@code pCoverageModulationTable} field. */
@Nullable
@NativeType("const float *")
public FloatBuffer pCoverageModulationTable() { return npCoverageModulationTable(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkPipelineCoverageModulationStateCreateInfoNV sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkPipelineCoverageModulationStateCreateInfoNV pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkPipelineCoverageModulationStateCreateInfoNV flags(@NativeType("VkPipelineCoverageModulationStateCreateFlagsNV") int value) { nflags(address(), value); return this; }
/** Sets the specified value to the {@code coverageModulationMode} field. */
public VkPipelineCoverageModulationStateCreateInfoNV coverageModulationMode(@NativeType("VkCoverageModulationModeNV") int value) { ncoverageModulationMode(address(), value); return this; }
/** Sets the specified value to the {@code coverageModulationTableEnable} field. */
public VkPipelineCoverageModulationStateCreateInfoNV coverageModulationTableEnable(@NativeType("VkBool32") boolean value) { ncoverageModulationTableEnable(address(), value ? 1 : 0); return this; }
/** Sets the specified value to the {@code coverageModulationTableCount} field. */
public VkPipelineCoverageModulationStateCreateInfoNV coverageModulationTableCount(@NativeType("uint32_t") int value) { ncoverageModulationTableCount(address(), value); return this; }
/** Sets the address of the specified {@link FloatBuffer} to the {@code pCoverageModulationTable} field. */
public VkPipelineCoverageModulationStateCreateInfoNV pCoverageModulationTable(@Nullable @NativeType("const float *") FloatBuffer value) { npCoverageModulationTable(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkPipelineCoverageModulationStateCreateInfoNV set(
int sType,
long pNext,
int flags,
int coverageModulationMode,
boolean coverageModulationTableEnable,
int coverageModulationTableCount,
FloatBuffer pCoverageModulationTable
) {
sType(sType);
pNext(pNext);
flags(flags);
coverageModulationMode(coverageModulationMode);
coverageModulationTableEnable(coverageModulationTableEnable);
coverageModulationTableCount(coverageModulationTableCount);
pCoverageModulationTable(pCoverageModulationTable);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkPipelineCoverageModulationStateCreateInfoNV set(VkPipelineCoverageModulationStateCreateInfoNV src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkPipelineCoverageModulationStateCreateInfoNV malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkPipelineCoverageModulationStateCreateInfoNV calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV} instance allocated with {@link BufferUtils}. */
public static VkPipelineCoverageModulationStateCreateInfoNV create() {
return new VkPipelineCoverageModulationStateCreateInfoNV(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV} instance for the specified memory address. */
public static VkPipelineCoverageModulationStateCreateInfoNV create(long address) {
return new VkPipelineCoverageModulationStateCreateInfoNV(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkPipelineCoverageModulationStateCreateInfoNV createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkPipelineCoverageModulationStateCreateInfoNV.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkPipelineCoverageModulationStateCreateInfoNV.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 VkPipelineCoverageModulationStateCreateInfoNV.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV} instance allocated on the thread-local {@link MemoryStack}. */
public static VkPipelineCoverageModulationStateCreateInfoNV mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkPipelineCoverageModulationStateCreateInfoNV callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkPipelineCoverageModulationStateCreateInfoNV mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkPipelineCoverageModulationStateCreateInfoNV callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkPipelineCoverageModulationStateCreateInfoNV.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkPipelineCoverageModulationStateCreateInfoNV.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 VkPipelineCoverageModulationStateCreateInfoNV.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 + VkPipelineCoverageModulationStateCreateInfoNV.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkPipelineCoverageModulationStateCreateInfoNV.PNEXT); }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return memGetInt(struct + VkPipelineCoverageModulationStateCreateInfoNV.FLAGS); }
/** Unsafe version of {@link #coverageModulationMode}. */
public static int ncoverageModulationMode(long struct) { return memGetInt(struct + VkPipelineCoverageModulationStateCreateInfoNV.COVERAGEMODULATIONMODE); }
/** Unsafe version of {@link #coverageModulationTableEnable}. */
public static int ncoverageModulationTableEnable(long struct) { return memGetInt(struct + VkPipelineCoverageModulationStateCreateInfoNV.COVERAGEMODULATIONTABLEENABLE); }
/** Unsafe version of {@link #coverageModulationTableCount}. */
public static int ncoverageModulationTableCount(long struct) { return memGetInt(struct + VkPipelineCoverageModulationStateCreateInfoNV.COVERAGEMODULATIONTABLECOUNT); }
/** Unsafe version of {@link #pCoverageModulationTable() pCoverageModulationTable}. */
@Nullable public static FloatBuffer npCoverageModulationTable(long struct) { return memFloatBufferSafe(memGetAddress(struct + VkPipelineCoverageModulationStateCreateInfoNV.PCOVERAGEMODULATIONTABLE), ncoverageModulationTableCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkPipelineCoverageModulationStateCreateInfoNV.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkPipelineCoverageModulationStateCreateInfoNV.PNEXT, value); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { memPutInt(struct + VkPipelineCoverageModulationStateCreateInfoNV.FLAGS, value); }
/** Unsafe version of {@link #coverageModulationMode(int) coverageModulationMode}. */
public static void ncoverageModulationMode(long struct, int value) { memPutInt(struct + VkPipelineCoverageModulationStateCreateInfoNV.COVERAGEMODULATIONMODE, value); }
/** Unsafe version of {@link #coverageModulationTableEnable(boolean) coverageModulationTableEnable}. */
public static void ncoverageModulationTableEnable(long struct, int value) { memPutInt(struct + VkPipelineCoverageModulationStateCreateInfoNV.COVERAGEMODULATIONTABLEENABLE, value); }
/** Sets the specified value to the {@code coverageModulationTableCount} field of the specified {@code struct}. */
public static void ncoverageModulationTableCount(long struct, int value) { memPutInt(struct + VkPipelineCoverageModulationStateCreateInfoNV.COVERAGEMODULATIONTABLECOUNT, value); }
/** Unsafe version of {@link #pCoverageModulationTable(FloatBuffer) pCoverageModulationTable}. */
public static void npCoverageModulationTable(long struct, @Nullable FloatBuffer value) { memPutAddress(struct + VkPipelineCoverageModulationStateCreateInfoNV.PCOVERAGEMODULATIONTABLE, memAddressSafe(value)); if (value != null) { ncoverageModulationTableCount(struct, value.remaining()); } }
// -----------------------------------
/** An array of {@link VkPipelineCoverageModulationStateCreateInfoNV} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkPipelineCoverageModulationStateCreateInfoNV.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 VkPipelineCoverageModulationStateCreateInfoNV#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 VkPipelineCoverageModulationStateCreateInfoNV newInstance(long address) {
return new VkPipelineCoverageModulationStateCreateInfoNV(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkPipelineCoverageModulationStateCreateInfoNV.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkPipelineCoverageModulationStateCreateInfoNV.npNext(address()); }
/** Returns the value of the {@code flags} field. */
@NativeType("VkPipelineCoverageModulationStateCreateFlagsNV")
public int flags() { return VkPipelineCoverageModulationStateCreateInfoNV.nflags(address()); }
/** Returns the value of the {@code coverageModulationMode} field. */
@NativeType("VkCoverageModulationModeNV")
public int coverageModulationMode() { return VkPipelineCoverageModulationStateCreateInfoNV.ncoverageModulationMode(address()); }
/** Returns the value of the {@code coverageModulationTableEnable} field. */
@NativeType("VkBool32")
public boolean coverageModulationTableEnable() { return VkPipelineCoverageModulationStateCreateInfoNV.ncoverageModulationTableEnable(address()) != 0; }
/** Returns the value of the {@code coverageModulationTableCount} field. */
@NativeType("uint32_t")
public int coverageModulationTableCount() { return VkPipelineCoverageModulationStateCreateInfoNV.ncoverageModulationTableCount(address()); }
/** Returns a {@link FloatBuffer} view of the data pointed to by the {@code pCoverageModulationTable} field. */
@Nullable
@NativeType("const float *")
public FloatBuffer pCoverageModulationTable() { return VkPipelineCoverageModulationStateCreateInfoNV.npCoverageModulationTable(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkPipelineCoverageModulationStateCreateInfoNV.Buffer sType(@NativeType("VkStructureType") int value) { VkPipelineCoverageModulationStateCreateInfoNV.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkPipelineCoverageModulationStateCreateInfoNV.Buffer pNext(@NativeType("const void *") long value) { VkPipelineCoverageModulationStateCreateInfoNV.npNext(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkPipelineCoverageModulationStateCreateInfoNV.Buffer flags(@NativeType("VkPipelineCoverageModulationStateCreateFlagsNV") int value) { VkPipelineCoverageModulationStateCreateInfoNV.nflags(address(), value); return this; }
/** Sets the specified value to the {@code coverageModulationMode} field. */
public VkPipelineCoverageModulationStateCreateInfoNV.Buffer coverageModulationMode(@NativeType("VkCoverageModulationModeNV") int value) { VkPipelineCoverageModulationStateCreateInfoNV.ncoverageModulationMode(address(), value); return this; }
/** Sets the specified value to the {@code coverageModulationTableEnable} field. */
public VkPipelineCoverageModulationStateCreateInfoNV.Buffer coverageModulationTableEnable(@NativeType("VkBool32") boolean value) { VkPipelineCoverageModulationStateCreateInfoNV.ncoverageModulationTableEnable(address(), value ? 1 : 0); return this; }
/** Sets the specified value to the {@code coverageModulationTableCount} field. */
public VkPipelineCoverageModulationStateCreateInfoNV.Buffer coverageModulationTableCount(@NativeType("uint32_t") int value) { VkPipelineCoverageModulationStateCreateInfoNV.ncoverageModulationTableCount(address(), value); return this; }
/** Sets the address of the specified {@link FloatBuffer} to the {@code pCoverageModulationTable} field. */
public VkPipelineCoverageModulationStateCreateInfoNV.Buffer pCoverageModulationTable(@Nullable @NativeType("const float *") FloatBuffer value) { VkPipelineCoverageModulationStateCreateInfoNV.npCoverageModulationTable(address(), value); return this; }
}
}