org.lwjgl.vulkan.VkAttachmentDescription 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 an attachment description.
*
* Description
*
* If the attachment uses a color format, then {@code loadOp} and {@code storeOp} are used, and {@code stencilLoadOp} and {@code stencilStoreOp} are ignored. If the format has depth and/or stencil components, {@code loadOp} and {@code storeOp} apply only to the depth data, while {@code stencilLoadOp} and {@code stencilStoreOp} define how the stencil data is handled. {@code loadOp} and {@code stencilLoadOp} define the load operations that execute as part of the first subpass that uses the attachment. {@code storeOp} and {@code stencilStoreOp} define the store operations that execute as part of the last subpass that uses the attachment.
*
* The load operation for each sample in an attachment happens-before any recorded command which accesses the sample in the first subpass where the attachment is used. Load operations for attachments with a depth/stencil format execute in the {@link VK10#VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT} pipeline stage. Load operations for attachments with a color format execute in the {@link VK10#VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT} pipeline stage.
*
* The store operation for each sample in an attachment happens-after any recorded command which accesses the sample in the last subpass where the attachment is used. Store operations for attachments with a depth/stencil format execute in the {@link VK10#VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT} pipeline stage. Store operations for attachments with a color format execute in the {@link VK10#VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT} pipeline stage.
*
* If an attachment is not used by any subpass, then {@code loadOp}, {@code storeOp}, {@code stencilStoreOp}, and {@code stencilLoadOp} are ignored, and the attachment's memory contents will not be modified by execution of a render pass instance.
*
* The load and store operations apply on the first and last use of each view in the render pass, respectively. If a view index of an attachment is not included in the view mask in any subpass that uses it, then the load and store operations are ignored, and the attachment's memory contents will not be modified by execution of a render pass instance.
*
* During a render pass instance, input/color attachments with color formats that have a component size of 8, 16, or 32 bits must be represented in the attachment's format throughout the instance. Attachments with other floating- or fixed-point color formats, or with depth components may be represented in a format with a precision higher than the attachment format, but must be represented with the same range. When such a component is loaded via the {@code loadOp}, it will be converted into an implementation-dependent format used by the render pass. Such components must be converted from the render pass format, to the format of the attachment, before they are resolved or stored at the end of a render pass instance via {@code storeOp}. Conversions occur as described in Numeric Representation and Computation and Fixed-Point Data Conversions.
*
* If {@code flags} includes {@link VK10#VK_ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT}, then the attachment is treated as if it shares physical memory with another attachment in the same render pass. This information limits the ability of the implementation to reorder certain operations (like layout transitions and the {@code loadOp}) such that it is not improperly reordered against other uses of the same physical memory via a different attachment. This is described in more detail below.
*
* Valid Usage
*
*
* - {@code finalLayout} must not be {@link VK10#VK_IMAGE_LAYOUT_UNDEFINED IMAGE_LAYOUT_UNDEFINED} or {@link VK10#VK_IMAGE_LAYOUT_PREINITIALIZED IMAGE_LAYOUT_PREINITIALIZED}
*
*
* Valid Usage (Implicit)
*
*
* - {@code flags} must be a valid combination of {@code VkAttachmentDescriptionFlagBits} values
* - {@code format} must be a valid {@code VkFormat} value
* - {@code samples} must be a valid {@code VkSampleCountFlagBits} value
* - {@code loadOp} must be a valid {@code VkAttachmentLoadOp} value
* - {@code storeOp} must be a valid {@code VkAttachmentStoreOp} value
* - {@code stencilLoadOp} must be a valid {@code VkAttachmentLoadOp} value
* - {@code stencilStoreOp} must be a valid {@code VkAttachmentStoreOp} value
* - {@code initialLayout} must be a valid {@code VkImageLayout} value
* - {@code finalLayout} must be a valid {@code VkImageLayout} value
*
*
* See Also
*
* {@link VkRenderPassCreateInfo}
*
* Member documentation
*
*
* - {@code flags} – a bitmask of {@code VkAttachmentDescriptionFlagBits} specifying additional properties of the attachment.
* - {@code format} – a {@code VkFormat} value specifying the format of the image that will be used for the attachment.
* - {@code samples} – the number of samples of the image as defined in {@code VkSampleCountFlagBits}.
* - {@code loadOp} – a {@code VkAttachmentLoadOp} value specifying how the contents of color and depth components of the attachment are treated at the beginning of the subpass where it is first used.
* - {@code storeOp} – a {@code VkAttachmentStoreOp} value specifying how the contents of color and depth components of the attachment are treated at the end of the subpass where it is last used.
* - {@code stencilLoadOp} – a {@code VkAttachmentLoadOp} value specifying how the contents of stencil components of the attachment are treated at the beginning of the subpass where it is first used.
* - {@code stencilStoreOp} – a {@code VkAttachmentStoreOp} value specifying how the contents of stencil components of the attachment are treated at the end of the last subpass where it is used.
* - {@code initialLayout} – the layout the attachment image subresource will be in when a render pass instance begins.
* - {@code finalLayout} – the layout the attachment image subresource will be transitioned to when a render pass instance ends. During a render pass instance, an attachment can use a different layout in each subpass, if desired.
*
*
* Layout
*
*
* struct VkAttachmentDescription {
* VkAttachmentDescriptionFlags flags;
* VkFormat format;
* VkSampleCountFlagBits samples;
* VkAttachmentLoadOp loadOp;
* VkAttachmentStoreOp storeOp;
* VkAttachmentLoadOp stencilLoadOp;
* VkAttachmentStoreOp stencilStoreOp;
* VkImageLayout initialLayout;
* VkImageLayout finalLayout;
* }The created instance holds a strong reference to the container object.
*/
public VkAttachmentDescription(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code flags} field. */
@NativeType("VkAttachmentDescriptionFlags")
public int flags() { return nflags(address()); }
/** Returns the value of the {@code format} field. */
@NativeType("VkFormat")
public int format() { return nformat(address()); }
/** Returns the value of the {@code samples} field. */
@NativeType("VkSampleCountFlagBits")
public int samples() { return nsamples(address()); }
/** Returns the value of the {@code loadOp} field. */
@NativeType("VkAttachmentLoadOp")
public int loadOp() { return nloadOp(address()); }
/** Returns the value of the {@code storeOp} field. */
@NativeType("VkAttachmentStoreOp")
public int storeOp() { return nstoreOp(address()); }
/** Returns the value of the {@code stencilLoadOp} field. */
@NativeType("VkAttachmentLoadOp")
public int stencilLoadOp() { return nstencilLoadOp(address()); }
/** Returns the value of the {@code stencilStoreOp} field. */
@NativeType("VkAttachmentStoreOp")
public int stencilStoreOp() { return nstencilStoreOp(address()); }
/** Returns the value of the {@code initialLayout} field. */
@NativeType("VkImageLayout")
public int initialLayout() { return ninitialLayout(address()); }
/** Returns the value of the {@code finalLayout} field. */
@NativeType("VkImageLayout")
public int finalLayout() { return nfinalLayout(address()); }
/** Sets the specified value to the {@code flags} field. */
public VkAttachmentDescription flags(@NativeType("VkAttachmentDescriptionFlags") int value) { nflags(address(), value); return this; }
/** Sets the specified value to the {@code format} field. */
public VkAttachmentDescription format(@NativeType("VkFormat") int value) { nformat(address(), value); return this; }
/** Sets the specified value to the {@code samples} field. */
public VkAttachmentDescription samples(@NativeType("VkSampleCountFlagBits") int value) { nsamples(address(), value); return this; }
/** Sets the specified value to the {@code loadOp} field. */
public VkAttachmentDescription loadOp(@NativeType("VkAttachmentLoadOp") int value) { nloadOp(address(), value); return this; }
/** Sets the specified value to the {@code storeOp} field. */
public VkAttachmentDescription storeOp(@NativeType("VkAttachmentStoreOp") int value) { nstoreOp(address(), value); return this; }
/** Sets the specified value to the {@code stencilLoadOp} field. */
public VkAttachmentDescription stencilLoadOp(@NativeType("VkAttachmentLoadOp") int value) { nstencilLoadOp(address(), value); return this; }
/** Sets the specified value to the {@code stencilStoreOp} field. */
public VkAttachmentDescription stencilStoreOp(@NativeType("VkAttachmentStoreOp") int value) { nstencilStoreOp(address(), value); return this; }
/** Sets the specified value to the {@code initialLayout} field. */
public VkAttachmentDescription initialLayout(@NativeType("VkImageLayout") int value) { ninitialLayout(address(), value); return this; }
/** Sets the specified value to the {@code finalLayout} field. */
public VkAttachmentDescription finalLayout(@NativeType("VkImageLayout") int value) { nfinalLayout(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkAttachmentDescription set(
int flags,
int format,
int samples,
int loadOp,
int storeOp,
int stencilLoadOp,
int stencilStoreOp,
int initialLayout,
int finalLayout
) {
flags(flags);
format(format);
samples(samples);
loadOp(loadOp);
storeOp(storeOp);
stencilLoadOp(stencilLoadOp);
stencilStoreOp(stencilStoreOp);
initialLayout(initialLayout);
finalLayout(finalLayout);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkAttachmentDescription set(VkAttachmentDescription src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkAttachmentDescription} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkAttachmentDescription malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkAttachmentDescription} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkAttachmentDescription calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkAttachmentDescription} instance allocated with {@link BufferUtils}. */
public static VkAttachmentDescription create() {
return new VkAttachmentDescription(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkAttachmentDescription} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkAttachmentDescription create(long address) {
return address == NULL ? null : new VkAttachmentDescription(address, null);
}
/**
* Returns a new {@link VkAttachmentDescription.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(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkAttachmentDescription.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 VkAttachmentDescription.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkAttachmentDescription.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 VkAttachmentDescription} instance allocated on the thread-local {@link MemoryStack}. */
public static VkAttachmentDescription mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkAttachmentDescription} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkAttachmentDescription callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkAttachmentDescription} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkAttachmentDescription mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkAttachmentDescription} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkAttachmentDescription callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkAttachmentDescription.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 VkAttachmentDescription.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 VkAttachmentDescription.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 VkAttachmentDescription.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 #flags}. */
public static int nflags(long struct) { return memGetInt(struct + VkAttachmentDescription.FLAGS); }
/** Unsafe version of {@link #format}. */
public static int nformat(long struct) { return memGetInt(struct + VkAttachmentDescription.FORMAT); }
/** Unsafe version of {@link #samples}. */
public static int nsamples(long struct) { return memGetInt(struct + VkAttachmentDescription.SAMPLES); }
/** Unsafe version of {@link #loadOp}. */
public static int nloadOp(long struct) { return memGetInt(struct + VkAttachmentDescription.LOADOP); }
/** Unsafe version of {@link #storeOp}. */
public static int nstoreOp(long struct) { return memGetInt(struct + VkAttachmentDescription.STOREOP); }
/** Unsafe version of {@link #stencilLoadOp}. */
public static int nstencilLoadOp(long struct) { return memGetInt(struct + VkAttachmentDescription.STENCILLOADOP); }
/** Unsafe version of {@link #stencilStoreOp}. */
public static int nstencilStoreOp(long struct) { return memGetInt(struct + VkAttachmentDescription.STENCILSTOREOP); }
/** Unsafe version of {@link #initialLayout}. */
public static int ninitialLayout(long struct) { return memGetInt(struct + VkAttachmentDescription.INITIALLAYOUT); }
/** Unsafe version of {@link #finalLayout}. */
public static int nfinalLayout(long struct) { return memGetInt(struct + VkAttachmentDescription.FINALLAYOUT); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { memPutInt(struct + VkAttachmentDescription.FLAGS, value); }
/** Unsafe version of {@link #format(int) format}. */
public static void nformat(long struct, int value) { memPutInt(struct + VkAttachmentDescription.FORMAT, value); }
/** Unsafe version of {@link #samples(int) samples}. */
public static void nsamples(long struct, int value) { memPutInt(struct + VkAttachmentDescription.SAMPLES, value); }
/** Unsafe version of {@link #loadOp(int) loadOp}. */
public static void nloadOp(long struct, int value) { memPutInt(struct + VkAttachmentDescription.LOADOP, value); }
/** Unsafe version of {@link #storeOp(int) storeOp}. */
public static void nstoreOp(long struct, int value) { memPutInt(struct + VkAttachmentDescription.STOREOP, value); }
/** Unsafe version of {@link #stencilLoadOp(int) stencilLoadOp}. */
public static void nstencilLoadOp(long struct, int value) { memPutInt(struct + VkAttachmentDescription.STENCILLOADOP, value); }
/** Unsafe version of {@link #stencilStoreOp(int) stencilStoreOp}. */
public static void nstencilStoreOp(long struct, int value) { memPutInt(struct + VkAttachmentDescription.STENCILSTOREOP, value); }
/** Unsafe version of {@link #initialLayout(int) initialLayout}. */
public static void ninitialLayout(long struct, int value) { memPutInt(struct + VkAttachmentDescription.INITIALLAYOUT, value); }
/** Unsafe version of {@link #finalLayout(int) finalLayout}. */
public static void nfinalLayout(long struct, int value) { memPutInt(struct + VkAttachmentDescription.FINALLAYOUT, value); }
// -----------------------------------
/** An array of {@link VkAttachmentDescription} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkAttachmentDescription.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 VkAttachmentDescription#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 VkAttachmentDescription newInstance(long address) {
return new VkAttachmentDescription(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code flags} field. */
@NativeType("VkAttachmentDescriptionFlags")
public int flags() { return VkAttachmentDescription.nflags(address()); }
/** Returns the value of the {@code format} field. */
@NativeType("VkFormat")
public int format() { return VkAttachmentDescription.nformat(address()); }
/** Returns the value of the {@code samples} field. */
@NativeType("VkSampleCountFlagBits")
public int samples() { return VkAttachmentDescription.nsamples(address()); }
/** Returns the value of the {@code loadOp} field. */
@NativeType("VkAttachmentLoadOp")
public int loadOp() { return VkAttachmentDescription.nloadOp(address()); }
/** Returns the value of the {@code storeOp} field. */
@NativeType("VkAttachmentStoreOp")
public int storeOp() { return VkAttachmentDescription.nstoreOp(address()); }
/** Returns the value of the {@code stencilLoadOp} field. */
@NativeType("VkAttachmentLoadOp")
public int stencilLoadOp() { return VkAttachmentDescription.nstencilLoadOp(address()); }
/** Returns the value of the {@code stencilStoreOp} field. */
@NativeType("VkAttachmentStoreOp")
public int stencilStoreOp() { return VkAttachmentDescription.nstencilStoreOp(address()); }
/** Returns the value of the {@code initialLayout} field. */
@NativeType("VkImageLayout")
public int initialLayout() { return VkAttachmentDescription.ninitialLayout(address()); }
/** Returns the value of the {@code finalLayout} field. */
@NativeType("VkImageLayout")
public int finalLayout() { return VkAttachmentDescription.nfinalLayout(address()); }
/** Sets the specified value to the {@code flags} field. */
public VkAttachmentDescription.Buffer flags(@NativeType("VkAttachmentDescriptionFlags") int value) { VkAttachmentDescription.nflags(address(), value); return this; }
/** Sets the specified value to the {@code format} field. */
public VkAttachmentDescription.Buffer format(@NativeType("VkFormat") int value) { VkAttachmentDescription.nformat(address(), value); return this; }
/** Sets the specified value to the {@code samples} field. */
public VkAttachmentDescription.Buffer samples(@NativeType("VkSampleCountFlagBits") int value) { VkAttachmentDescription.nsamples(address(), value); return this; }
/** Sets the specified value to the {@code loadOp} field. */
public VkAttachmentDescription.Buffer loadOp(@NativeType("VkAttachmentLoadOp") int value) { VkAttachmentDescription.nloadOp(address(), value); return this; }
/** Sets the specified value to the {@code storeOp} field. */
public VkAttachmentDescription.Buffer storeOp(@NativeType("VkAttachmentStoreOp") int value) { VkAttachmentDescription.nstoreOp(address(), value); return this; }
/** Sets the specified value to the {@code stencilLoadOp} field. */
public VkAttachmentDescription.Buffer stencilLoadOp(@NativeType("VkAttachmentLoadOp") int value) { VkAttachmentDescription.nstencilLoadOp(address(), value); return this; }
/** Sets the specified value to the {@code stencilStoreOp} field. */
public VkAttachmentDescription.Buffer stencilStoreOp(@NativeType("VkAttachmentStoreOp") int value) { VkAttachmentDescription.nstencilStoreOp(address(), value); return this; }
/** Sets the specified value to the {@code initialLayout} field. */
public VkAttachmentDescription.Buffer initialLayout(@NativeType("VkImageLayout") int value) { VkAttachmentDescription.ninitialLayout(address(), value); return this; }
/** Sets the specified value to the {@code finalLayout} field. */
public VkAttachmentDescription.Buffer finalLayout(@NativeType("VkImageLayout") int value) { VkAttachmentDescription.nfinalLayout(address(), value); return this; }
}
}