org.lwjgl.vulkan.VkClearAttachment 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 a clear attachment.
*
* Description
*
* No memory barriers are needed between {@link VK10#vkCmdClearAttachments CmdClearAttachments} and preceding or subsequent draw or attachment clear commands in the same subpass.
*
* The {@link VK10#vkCmdClearAttachments CmdClearAttachments} command is not affected by the bound pipeline state.
*
* Attachments can also be cleared at the beginning of a render pass instance by setting {@code loadOp} (or {@code stencilLoadOp}) of {@link VkAttachmentDescription} to {@link VK10#VK_ATTACHMENT_LOAD_OP_CLEAR ATTACHMENT_LOAD_OP_CLEAR}, as described for {@link VK10#vkCreateRenderPass CreateRenderPass}.
*
* Valid Usage
*
*
* - If {@code aspectMask} includes {@link VK10#VK_IMAGE_ASPECT_COLOR_BIT IMAGE_ASPECT_COLOR_BIT}, it must not include {@link VK10#VK_IMAGE_ASPECT_DEPTH_BIT IMAGE_ASPECT_DEPTH_BIT} or {@link VK10#VK_IMAGE_ASPECT_STENCIL_BIT IMAGE_ASPECT_STENCIL_BIT}
* - {@code aspectMask} must not include {@link VK10#VK_IMAGE_ASPECT_METADATA_BIT IMAGE_ASPECT_METADATA_BIT}
* - {@code clearValue} must be a valid {@link VkClearValue} union
*
*
* Valid Usage (Implicit)
*
*
* - {@code aspectMask} must be a valid combination of {@code VkImageAspectFlagBits} values
* - {@code aspectMask} must not be 0
*
*
* See Also
*
* {@link VkClearValue}, {@link VK10#vkCmdClearAttachments CmdClearAttachments}
*
* Member documentation
*
*
* - {@code aspectMask} – a mask selecting the color, depth and/or stencil aspects of the attachment to be cleared. {@code aspectMask} can include {@link VK10#VK_IMAGE_ASPECT_COLOR_BIT IMAGE_ASPECT_COLOR_BIT} for color attachments, {@link VK10#VK_IMAGE_ASPECT_DEPTH_BIT IMAGE_ASPECT_DEPTH_BIT} for depth/stencil attachments with a depth component, and {@link VK10#VK_IMAGE_ASPECT_STENCIL_BIT IMAGE_ASPECT_STENCIL_BIT} for depth/stencil attachments with a stencil component. If the subpass’s depth/stencil attachment is {@link VK10#VK_ATTACHMENT_UNUSED ATTACHMENT_UNUSED}, then the clear has no effect.
* - {@code colorAttachment} – only meaningful if {@link VK10#VK_IMAGE_ASPECT_COLOR_BIT IMAGE_ASPECT_COLOR_BIT} is set in {@code aspectMask}, in which case it is an index to the {@code pColorAttachments} array in the {@link VkSubpassDescription} structure of the current subpass which selects the color attachment to clear. If {@code colorAttachment} is {@link VK10#VK_ATTACHMENT_UNUSED ATTACHMENT_UNUSED} then the clear has no effect.
* - {@code clearValue} – the color or depth/stencil value to clear the attachment to, as described in Clear Values below.
*
*
* Layout
*
*
* struct VkClearAttachment {
* VkImageAspectFlags aspectMask;
* uint32_t colorAttachment;
* {@link VkClearValue VkClearValue} clearValue;
* }The created instance holds a strong reference to the container object.
*/
public VkClearAttachment(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code aspectMask} field. */
@NativeType("VkImageAspectFlags")
public int aspectMask() { return naspectMask(address()); }
/** Returns the value of the {@code colorAttachment} field. */
@NativeType("uint32_t")
public int colorAttachment() { return ncolorAttachment(address()); }
/** Returns a {@link VkClearValue} view of the {@code clearValue} field. */
public VkClearValue clearValue() { return nclearValue(address()); }
/** Sets the specified value to the {@code aspectMask} field. */
public VkClearAttachment aspectMask(@NativeType("VkImageAspectFlags") int value) { naspectMask(address(), value); return this; }
/** Sets the specified value to the {@code colorAttachment} field. */
public VkClearAttachment colorAttachment(@NativeType("uint32_t") int value) { ncolorAttachment(address(), value); return this; }
/** Copies the specified {@link VkClearValue} to the {@code clearValue} field. */
public VkClearAttachment clearValue(VkClearValue value) { nclearValue(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkClearAttachment set(
int aspectMask,
int colorAttachment,
VkClearValue clearValue
) {
aspectMask(aspectMask);
colorAttachment(colorAttachment);
clearValue(clearValue);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkClearAttachment set(VkClearAttachment src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkClearAttachment} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkClearAttachment malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkClearAttachment} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkClearAttachment calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkClearAttachment} instance allocated with {@link BufferUtils}. */
public static VkClearAttachment create() {
return new VkClearAttachment(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkClearAttachment} instance for the specified memory address. */
public static VkClearAttachment create(long address) {
return new VkClearAttachment(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkClearAttachment createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkClearAttachment.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkClearAttachment.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkClearAttachment.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkClearAttachment.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkClearAttachment.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkClearAttachment.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkClearAttachment.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkClearAttachment.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 VkClearAttachment.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkClearAttachment} instance allocated on the thread-local {@link MemoryStack}. */
public static VkClearAttachment mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkClearAttachment} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkClearAttachment callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkClearAttachment} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkClearAttachment mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkClearAttachment} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkClearAttachment callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkClearAttachment.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkClearAttachment.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkClearAttachment.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkClearAttachment.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkClearAttachment.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkClearAttachment.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkClearAttachment.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 VkClearAttachment.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #aspectMask}. */
public static int naspectMask(long struct) { return memGetInt(struct + VkClearAttachment.ASPECTMASK); }
/** Unsafe version of {@link #colorAttachment}. */
public static int ncolorAttachment(long struct) { return memGetInt(struct + VkClearAttachment.COLORATTACHMENT); }
/** Unsafe version of {@link #clearValue}. */
public static VkClearValue nclearValue(long struct) { return VkClearValue.create(struct + VkClearAttachment.CLEARVALUE); }
/** Unsafe version of {@link #aspectMask(int) aspectMask}. */
public static void naspectMask(long struct, int value) { memPutInt(struct + VkClearAttachment.ASPECTMASK, value); }
/** Unsafe version of {@link #colorAttachment(int) colorAttachment}. */
public static void ncolorAttachment(long struct, int value) { memPutInt(struct + VkClearAttachment.COLORATTACHMENT, value); }
/** Unsafe version of {@link #clearValue(VkClearValue) clearValue}. */
public static void nclearValue(long struct, VkClearValue value) { memCopy(value.address(), struct + VkClearAttachment.CLEARVALUE, VkClearValue.SIZEOF); }
// -----------------------------------
/** An array of {@link VkClearAttachment} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkClearAttachment.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 VkClearAttachment#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 VkClearAttachment newInstance(long address) {
return new VkClearAttachment(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code aspectMask} field. */
@NativeType("VkImageAspectFlags")
public int aspectMask() { return VkClearAttachment.naspectMask(address()); }
/** Returns the value of the {@code colorAttachment} field. */
@NativeType("uint32_t")
public int colorAttachment() { return VkClearAttachment.ncolorAttachment(address()); }
/** Returns a {@link VkClearValue} view of the {@code clearValue} field. */
public VkClearValue clearValue() { return VkClearAttachment.nclearValue(address()); }
/** Sets the specified value to the {@code aspectMask} field. */
public VkClearAttachment.Buffer aspectMask(@NativeType("VkImageAspectFlags") int value) { VkClearAttachment.naspectMask(address(), value); return this; }
/** Sets the specified value to the {@code colorAttachment} field. */
public VkClearAttachment.Buffer colorAttachment(@NativeType("uint32_t") int value) { VkClearAttachment.ncolorAttachment(address(), value); return this; }
/** Copies the specified {@link VkClearValue} to the {@code clearValue} field. */
public VkClearAttachment.Buffer clearValue(VkClearValue value) { VkClearAttachment.nclearValue(address(), value); return this; }
}
}