org.lwjgl.vulkan.VkPipelineMultisampleStateCreateInfo 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 java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying parameters of a newly created pipeline multisample state.
*
* Valid Usage
*
*
* - If the sample rate shading feature is not enabled, {@code sampleShadingEnable} must be {@link VK10#VK_FALSE FALSE}
* - If the alpha to one feature is not enabled, {@code alphaToOneEnable} must be {@link VK10#VK_FALSE FALSE}
* - {@code minSampleShading} must be in the range
[0,1]
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK10#VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO}
* - {@code pNext} must be {@code NULL}
* - {@code flags} must be 0
* - {@code rasterizationSamples} must be a valid {@code VkSampleCountFlagBits} value
* - If {@code pSampleMask} is not {@code NULL}, {@code pSampleMask} must be a pointer to an array of
ceil(rasterizationSamples / 32) {@code VkSampleMask} values
*
*
* See Also
*
* {@link VkGraphicsPipelineCreateInfo}
*
* 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 rasterizationSamples} – a {@code VkSampleCountFlagBits} specifying the number of samples per pixel used in rasterization.
* - {@code sampleShadingEnable} – specifies that fragment shading executes per-sample if {@link VK10#VK_TRUE TRUE}, or per-fragment if {@link VK10#VK_FALSE FALSE}, as described in Sample Shading.
* - {@code minSampleShading} – the minimum fraction of sample shading, as described in Sample Shading.
* - {@code pSampleMask} – a bitmask of static coverage information that is ANDed with the coverage information generated during rasterization, as described in Sample Mask.
* - {@code alphaToCoverageEnable} – controls whether a temporary coverage value is generated based on the alpha component of the fragment’s first color output as specified in the Multisample Coverage section.
* - {@code alphaToOneEnable} – controls whether the alpha component of the fragment’s first color output is replaced with one as described in Multisample Coverage.
*
*
* Layout
*
* struct VkPipelineMultisampleStateCreateInfo {
VkStructureType sType;
const void * pNext;
VkPipelineMultisampleStateCreateFlags flags;
VkSampleCountFlagBits rasterizationSamples;
VkBool32 sampleShadingEnable;
float minSampleShading;
const VkSampleMask * pSampleMask;
VkBool32 alphaToCoverageEnable;
VkBool32 alphaToOneEnable;
}
*/
public class VkPipelineMultisampleStateCreateInfo extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
STYPE,
PNEXT,
FLAGS,
RASTERIZATIONSAMPLES,
SAMPLESHADINGENABLE,
MINSAMPLESHADING,
PSAMPLEMASK,
ALPHATOCOVERAGEENABLE,
ALPHATOONEENABLE;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(4),
__member(4),
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
STYPE = layout.offsetof(0);
PNEXT = layout.offsetof(1);
FLAGS = layout.offsetof(2);
RASTERIZATIONSAMPLES = layout.offsetof(3);
SAMPLESHADINGENABLE = layout.offsetof(4);
MINSAMPLESHADING = layout.offsetof(5);
PSAMPLEMASK = layout.offsetof(6);
ALPHATOCOVERAGEENABLE = layout.offsetof(7);
ALPHATOONEENABLE = layout.offsetof(8);
}
VkPipelineMultisampleStateCreateInfo(long address, ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link VkPipelineMultisampleStateCreateInfo} instance at the current position of the specified {@link ByteBuffer} 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.
*/
public VkPipelineMultisampleStateCreateInfo(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
public long pNext() { return npNext(address()); }
/** Returns the value of the {@code flags} field. */
public int flags() { return nflags(address()); }
/** Returns the value of the {@code rasterizationSamples} field. */
public int rasterizationSamples() { return nrasterizationSamples(address()); }
/** Returns the value of the {@code sampleShadingEnable} field. */
public boolean sampleShadingEnable() { return nsampleShadingEnable(address()) != 0; }
/** Returns the value of the {@code minSampleShading} field. */
public float minSampleShading() { return nminSampleShading(address()); }
/**
* Returns a {@link IntBuffer} view of the data pointed to by the {@code pSampleMask} field.
*
* @param capacity the number of elements in the returned buffer
*/
public IntBuffer pSampleMask(int capacity) { return npSampleMask(address(), capacity); }
/** Returns the value of the {@code alphaToCoverageEnable} field. */
public boolean alphaToCoverageEnable() { return nalphaToCoverageEnable(address()) != 0; }
/** Returns the value of the {@code alphaToOneEnable} field. */
public boolean alphaToOneEnable() { return nalphaToOneEnable(address()) != 0; }
/** Sets the specified value to the {@code sType} field. */
public VkPipelineMultisampleStateCreateInfo sType(int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkPipelineMultisampleStateCreateInfo pNext(long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkPipelineMultisampleStateCreateInfo flags(int value) { nflags(address(), value); return this; }
/** Sets the specified value to the {@code rasterizationSamples} field. */
public VkPipelineMultisampleStateCreateInfo rasterizationSamples(int value) { nrasterizationSamples(address(), value); return this; }
/** Sets the specified value to the {@code sampleShadingEnable} field. */
public VkPipelineMultisampleStateCreateInfo sampleShadingEnable(boolean value) { nsampleShadingEnable(address(), value ? 1 : 0); return this; }
/** Sets the specified value to the {@code minSampleShading} field. */
public VkPipelineMultisampleStateCreateInfo minSampleShading(float value) { nminSampleShading(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@code pSampleMask} field. */
public VkPipelineMultisampleStateCreateInfo pSampleMask(IntBuffer value) { npSampleMask(address(), value); return this; }
/** Sets the specified value to the {@code alphaToCoverageEnable} field. */
public VkPipelineMultisampleStateCreateInfo alphaToCoverageEnable(boolean value) { nalphaToCoverageEnable(address(), value ? 1 : 0); return this; }
/** Sets the specified value to the {@code alphaToOneEnable} field. */
public VkPipelineMultisampleStateCreateInfo alphaToOneEnable(boolean value) { nalphaToOneEnable(address(), value ? 1 : 0); return this; }
/** Initializes this struct with the specified values. */
public VkPipelineMultisampleStateCreateInfo set(
int sType,
long pNext,
int flags,
int rasterizationSamples,
boolean sampleShadingEnable,
float minSampleShading,
IntBuffer pSampleMask,
boolean alphaToCoverageEnable,
boolean alphaToOneEnable
) {
sType(sType);
pNext(pNext);
flags(flags);
rasterizationSamples(rasterizationSamples);
sampleShadingEnable(sampleShadingEnable);
minSampleShading(minSampleShading);
pSampleMask(pSampleMask);
alphaToCoverageEnable(alphaToCoverageEnable);
alphaToOneEnable(alphaToOneEnable);
return this;
}
/** Unsafe version of {@link #set(VkPipelineMultisampleStateCreateInfo) set}. */
public VkPipelineMultisampleStateCreateInfo nset(long struct) {
memCopy(struct, address(), SIZEOF);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkPipelineMultisampleStateCreateInfo set(VkPipelineMultisampleStateCreateInfo src) {
return nset(src.address());
}
// -----------------------------------
/** Returns a new {@link VkPipelineMultisampleStateCreateInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkPipelineMultisampleStateCreateInfo malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkPipelineMultisampleStateCreateInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkPipelineMultisampleStateCreateInfo calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkPipelineMultisampleStateCreateInfo} instance allocated with {@link BufferUtils}. */
public static VkPipelineMultisampleStateCreateInfo create() {
return new VkPipelineMultisampleStateCreateInfo(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkPipelineMultisampleStateCreateInfo} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkPipelineMultisampleStateCreateInfo create(long address) {
return address == NULL ? null : new VkPipelineMultisampleStateCreateInfo(address, null);
}
/**
* Returns a new {@link VkPipelineMultisampleStateCreateInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer malloc(int capacity) {
return create(nmemAlloc(capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkPipelineMultisampleStateCreateInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkPipelineMultisampleStateCreateInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(BufferUtils.createByteBuffer(capacity * SIZEOF));
}
/**
* Create a {@link VkPipelineMultisampleStateCreateInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link VkPipelineMultisampleStateCreateInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VkPipelineMultisampleStateCreateInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkPipelineMultisampleStateCreateInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkPipelineMultisampleStateCreateInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkPipelineMultisampleStateCreateInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkPipelineMultisampleStateCreateInfo mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkPipelineMultisampleStateCreateInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkPipelineMultisampleStateCreateInfo callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkPipelineMultisampleStateCreateInfo.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkPipelineMultisampleStateCreateInfo.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkPipelineMultisampleStateCreateInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkPipelineMultisampleStateCreateInfo.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 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 + VkPipelineMultisampleStateCreateInfo.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkPipelineMultisampleStateCreateInfo.PNEXT); }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return memGetInt(struct + VkPipelineMultisampleStateCreateInfo.FLAGS); }
/** Unsafe version of {@link #rasterizationSamples}. */
public static int nrasterizationSamples(long struct) { return memGetInt(struct + VkPipelineMultisampleStateCreateInfo.RASTERIZATIONSAMPLES); }
/** Unsafe version of {@link #sampleShadingEnable}. */
public static int nsampleShadingEnable(long struct) { return memGetInt(struct + VkPipelineMultisampleStateCreateInfo.SAMPLESHADINGENABLE); }
/** Unsafe version of {@link #minSampleShading}. */
public static float nminSampleShading(long struct) { return memGetFloat(struct + VkPipelineMultisampleStateCreateInfo.MINSAMPLESHADING); }
/** Unsafe version of {@link #pSampleMask(int) pSampleMask}. */
public static IntBuffer npSampleMask(long struct, int capacity) { return memIntBuffer(memGetAddress(struct + VkPipelineMultisampleStateCreateInfo.PSAMPLEMASK), capacity); }
/** Unsafe version of {@link #alphaToCoverageEnable}. */
public static int nalphaToCoverageEnable(long struct) { return memGetInt(struct + VkPipelineMultisampleStateCreateInfo.ALPHATOCOVERAGEENABLE); }
/** Unsafe version of {@link #alphaToOneEnable}. */
public static int nalphaToOneEnable(long struct) { return memGetInt(struct + VkPipelineMultisampleStateCreateInfo.ALPHATOONEENABLE); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkPipelineMultisampleStateCreateInfo.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkPipelineMultisampleStateCreateInfo.PNEXT, value); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { memPutInt(struct + VkPipelineMultisampleStateCreateInfo.FLAGS, value); }
/** Unsafe version of {@link #rasterizationSamples(int) rasterizationSamples}. */
public static void nrasterizationSamples(long struct, int value) { memPutInt(struct + VkPipelineMultisampleStateCreateInfo.RASTERIZATIONSAMPLES, value); }
/** Unsafe version of {@link #sampleShadingEnable(boolean) sampleShadingEnable}. */
public static void nsampleShadingEnable(long struct, int value) { memPutInt(struct + VkPipelineMultisampleStateCreateInfo.SAMPLESHADINGENABLE, value); }
/** Unsafe version of {@link #minSampleShading(float) minSampleShading}. */
public static void nminSampleShading(long struct, float value) { memPutFloat(struct + VkPipelineMultisampleStateCreateInfo.MINSAMPLESHADING, value); }
/** Unsafe version of {@link #pSampleMask(IntBuffer) pSampleMask}. */
public static void npSampleMask(long struct, IntBuffer value) { memPutAddress(struct + VkPipelineMultisampleStateCreateInfo.PSAMPLEMASK, memAddressSafe(value)); }
/** Unsafe version of {@link #alphaToCoverageEnable(boolean) alphaToCoverageEnable}. */
public static void nalphaToCoverageEnable(long struct, int value) { memPutInt(struct + VkPipelineMultisampleStateCreateInfo.ALPHATOCOVERAGEENABLE, value); }
/** Unsafe version of {@link #alphaToOneEnable(boolean) alphaToOneEnable}. */
public static void nalphaToOneEnable(long struct, int value) { memPutInt(struct + VkPipelineMultisampleStateCreateInfo.ALPHATOONEENABLE, value); }
// -----------------------------------
/** An array of {@link VkPipelineMultisampleStateCreateInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkPipelineMultisampleStateCreateInfo.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 VkPipelineMultisampleStateCreateInfo#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);
}
Buffer(long address, 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, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkPipelineMultisampleStateCreateInfo newInstance(long address) {
return new VkPipelineMultisampleStateCreateInfo(address, container);
}
@Override
protected int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
public int sType() { return VkPipelineMultisampleStateCreateInfo.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
public long pNext() { return VkPipelineMultisampleStateCreateInfo.npNext(address()); }
/** Returns the value of the {@code flags} field. */
public int flags() { return VkPipelineMultisampleStateCreateInfo.nflags(address()); }
/** Returns the value of the {@code rasterizationSamples} field. */
public int rasterizationSamples() { return VkPipelineMultisampleStateCreateInfo.nrasterizationSamples(address()); }
/** Returns the value of the {@code sampleShadingEnable} field. */
public boolean sampleShadingEnable() { return VkPipelineMultisampleStateCreateInfo.nsampleShadingEnable(address()) != 0; }
/** Returns the value of the {@code minSampleShading} field. */
public float minSampleShading() { return VkPipelineMultisampleStateCreateInfo.nminSampleShading(address()); }
/**
* Returns a {@link IntBuffer} view of the data pointed to by the {@code pSampleMask} field.
*
* @param capacity the number of elements in the returned buffer
*/
public IntBuffer pSampleMask(int capacity) { return VkPipelineMultisampleStateCreateInfo.npSampleMask(address(), capacity); }
/** Returns the value of the {@code alphaToCoverageEnable} field. */
public boolean alphaToCoverageEnable() { return VkPipelineMultisampleStateCreateInfo.nalphaToCoverageEnable(address()) != 0; }
/** Returns the value of the {@code alphaToOneEnable} field. */
public boolean alphaToOneEnable() { return VkPipelineMultisampleStateCreateInfo.nalphaToOneEnable(address()) != 0; }
/** Sets the specified value to the {@code sType} field. */
public VkPipelineMultisampleStateCreateInfo.Buffer sType(int value) { VkPipelineMultisampleStateCreateInfo.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkPipelineMultisampleStateCreateInfo.Buffer pNext(long value) { VkPipelineMultisampleStateCreateInfo.npNext(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkPipelineMultisampleStateCreateInfo.Buffer flags(int value) { VkPipelineMultisampleStateCreateInfo.nflags(address(), value); return this; }
/** Sets the specified value to the {@code rasterizationSamples} field. */
public VkPipelineMultisampleStateCreateInfo.Buffer rasterizationSamples(int value) { VkPipelineMultisampleStateCreateInfo.nrasterizationSamples(address(), value); return this; }
/** Sets the specified value to the {@code sampleShadingEnable} field. */
public VkPipelineMultisampleStateCreateInfo.Buffer sampleShadingEnable(boolean value) { VkPipelineMultisampleStateCreateInfo.nsampleShadingEnable(address(), value ? 1 : 0); return this; }
/** Sets the specified value to the {@code minSampleShading} field. */
public VkPipelineMultisampleStateCreateInfo.Buffer minSampleShading(float value) { VkPipelineMultisampleStateCreateInfo.nminSampleShading(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@code pSampleMask} field. */
public VkPipelineMultisampleStateCreateInfo.Buffer pSampleMask(IntBuffer value) { VkPipelineMultisampleStateCreateInfo.npSampleMask(address(), value); return this; }
/** Sets the specified value to the {@code alphaToCoverageEnable} field. */
public VkPipelineMultisampleStateCreateInfo.Buffer alphaToCoverageEnable(boolean value) { VkPipelineMultisampleStateCreateInfo.nalphaToCoverageEnable(address(), value ? 1 : 0); return this; }
/** Sets the specified value to the {@code alphaToOneEnable} field. */
public VkPipelineMultisampleStateCreateInfo.Buffer alphaToOneEnable(boolean value) { VkPipelineMultisampleStateCreateInfo.nalphaToOneEnable(address(), value ? 1 : 0); return this; }
}
}