org.lwjgl.vulkan.VkRenderPassBeginInfo 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying render pass begin info.
*
* Description
*
* {@code renderArea} is the render area that is affected by the render pass instance. The effects of attachment load, store and multisample resolve operations are restricted to the pixels whose x and y coordinates fall within the render area on all attachments. The render area extends to all layers of {@code framebuffer}. The application must ensure (using scissor if necessary) that all rendering is contained within the render area, otherwise the pixels outside of the render area become undefined and shader side effects may occur for fragments outside the render area. The render area must be contained within the framebuffer dimensions.
*
* When multiview is enabled, the resolve operation at the end of a subpass applies to all views in the view mask.
*
* Note
*
* There may be a performance cost for using a render area smaller than the framebuffer, unless it matches the render area granularity for the render pass.
*
*
* Valid Usage
*
*
* - {@code clearValueCount} must be greater than the largest attachment index in {@code renderPass} that specifies a {@code loadOp} (or {@code stencilLoadOp}, if the attachment has a depth/stencil format) of {@link VK10#VK_ATTACHMENT_LOAD_OP_CLEAR ATTACHMENT_LOAD_OP_CLEAR}
* - If {@code clearValueCount} is not 0, {@code pClearValues} must be a pointer to an array of {@code clearValueCount} valid {@link VkClearValue} unions
* - {@code renderPass} must be compatible with the {@code renderPass} member of the {@link VkFramebufferCreateInfo} structure specified when creating {@code framebuffer}.
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK10#VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO}
* - Each {@code pNext} member of any structure (including this one) in the {@code pNext} chain must be either {@code NULL} or a pointer to a valid instance of {@link VkDeviceGroupRenderPassBeginInfoKHX} or {@link VkRenderPassSampleLocationsBeginInfoEXT}
* - Each {@code sType} member in the {@code pNext} chain must be unique
* - {@code renderPass} must be a valid {@code VkRenderPass} handle
* - {@code framebuffer} must be a valid {@code VkFramebuffer} handle
* - Both of {@code framebuffer}, and {@code renderPass} must have been created, allocated, or retrieved from the same {@code VkDevice}
*
*
* See Also
*
* {@link VkClearValue}, {@link VkRect2D}, {@link VK10#vkCmdBeginRenderPass CmdBeginRenderPass}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code renderPass} – the render pass to begin an instance of.
* - {@code framebuffer} – the framebuffer containing the attachments that are used with the render pass.
* - {@code renderArea} – the render area that is affected by the render pass instance, and is described in more detail below.
* - {@code clearValueCount} – the number of elements in {@code pClearValues}.
* - {@code pClearValues} – an array of {@link VkClearValue} structures that contains clear values for each attachment, if the attachment uses a {@code loadOp} value of {@link VK10#VK_ATTACHMENT_LOAD_OP_CLEAR ATTACHMENT_LOAD_OP_CLEAR} or if the attachment has a depth/stencil format and uses a {@code stencilLoadOp} value of {@link VK10#VK_ATTACHMENT_LOAD_OP_CLEAR ATTACHMENT_LOAD_OP_CLEAR}. The array is indexed by attachment number. Only elements corresponding to cleared attachments are used. Other elements of {@code pClearValues} are ignored.
*
*
* Layout
*
*
* struct VkRenderPassBeginInfo {
* VkStructureType sType;
* const void * pNext;
* VkRenderPass renderPass;
* VkFramebuffer framebuffer;
* {@link VkRect2D VkRect2D} renderArea;
* uint32_t clearValueCount;
* const {@link VkClearValue VkClearValue} * pClearValues;
* }The created instance holds a strong reference to the container object.
*/
public VkRenderPassBeginInfo(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 renderPass} field. */
@NativeType("VkRenderPass")
public long renderPass() { return nrenderPass(address()); }
/** Returns the value of the {@code framebuffer} field. */
@NativeType("VkFramebuffer")
public long framebuffer() { return nframebuffer(address()); }
/** Returns a {@link VkRect2D} view of the {@code renderArea} field. */
public VkRect2D renderArea() { return nrenderArea(address()); }
/** Returns the value of the {@code clearValueCount} field. */
@NativeType("uint32_t")
public int clearValueCount() { return nclearValueCount(address()); }
/** Returns a {@link VkClearValue.Buffer} view of the struct array pointed to by the {@code pClearValues} field. */
@NativeType("const VkClearValue *")
public VkClearValue.Buffer pClearValues() { return npClearValues(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkRenderPassBeginInfo sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkRenderPassBeginInfo pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code renderPass} field. */
public VkRenderPassBeginInfo renderPass(@NativeType("VkRenderPass") long value) { nrenderPass(address(), value); return this; }
/** Sets the specified value to the {@code framebuffer} field. */
public VkRenderPassBeginInfo framebuffer(@NativeType("VkFramebuffer") long value) { nframebuffer(address(), value); return this; }
/** Copies the specified {@link VkRect2D} to the {@code renderArea} field. */
public VkRenderPassBeginInfo renderArea(VkRect2D value) { nrenderArea(address(), value); return this; }
/** Sets the address of the specified {@link VkClearValue.Buffer} to the {@code pClearValues} field. */
public VkRenderPassBeginInfo pClearValues(@NativeType("const VkClearValue *") VkClearValue.Buffer value) { npClearValues(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkRenderPassBeginInfo set(
int sType,
long pNext,
long renderPass,
long framebuffer,
VkRect2D renderArea,
VkClearValue.Buffer pClearValues
) {
sType(sType);
pNext(pNext);
renderPass(renderPass);
framebuffer(framebuffer);
renderArea(renderArea);
pClearValues(pClearValues);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkRenderPassBeginInfo set(VkRenderPassBeginInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkRenderPassBeginInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkRenderPassBeginInfo malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkRenderPassBeginInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkRenderPassBeginInfo calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkRenderPassBeginInfo} instance allocated with {@link BufferUtils}. */
public static VkRenderPassBeginInfo create() {
return new VkRenderPassBeginInfo(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkRenderPassBeginInfo} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkRenderPassBeginInfo create(long address) {
return address == NULL ? null : new VkRenderPassBeginInfo(address, null);
}
/**
* Returns a new {@link VkRenderPassBeginInfo.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 VkRenderPassBeginInfo.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 VkRenderPassBeginInfo.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 VkRenderPassBeginInfo.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 VkRenderPassBeginInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VkRenderPassBeginInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkRenderPassBeginInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkRenderPassBeginInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkRenderPassBeginInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkRenderPassBeginInfo mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkRenderPassBeginInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkRenderPassBeginInfo callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkRenderPassBeginInfo.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 VkRenderPassBeginInfo.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 VkRenderPassBeginInfo.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 VkRenderPassBeginInfo.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 + VkRenderPassBeginInfo.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkRenderPassBeginInfo.PNEXT); }
/** Unsafe version of {@link #renderPass}. */
public static long nrenderPass(long struct) { return memGetLong(struct + VkRenderPassBeginInfo.RENDERPASS); }
/** Unsafe version of {@link #framebuffer}. */
public static long nframebuffer(long struct) { return memGetLong(struct + VkRenderPassBeginInfo.FRAMEBUFFER); }
/** Unsafe version of {@link #renderArea}. */
public static VkRect2D nrenderArea(long struct) { return VkRect2D.create(struct + VkRenderPassBeginInfo.RENDERAREA); }
/** Unsafe version of {@link #clearValueCount}. */
public static int nclearValueCount(long struct) { return memGetInt(struct + VkRenderPassBeginInfo.CLEARVALUECOUNT); }
/** Unsafe version of {@link #pClearValues}. */
public static VkClearValue.Buffer npClearValues(long struct) { return VkClearValue.create(memGetAddress(struct + VkRenderPassBeginInfo.PCLEARVALUES), nclearValueCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkRenderPassBeginInfo.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkRenderPassBeginInfo.PNEXT, value); }
/** Unsafe version of {@link #renderPass(long) renderPass}. */
public static void nrenderPass(long struct, long value) { memPutLong(struct + VkRenderPassBeginInfo.RENDERPASS, value); }
/** Unsafe version of {@link #framebuffer(long) framebuffer}. */
public static void nframebuffer(long struct, long value) { memPutLong(struct + VkRenderPassBeginInfo.FRAMEBUFFER, value); }
/** Unsafe version of {@link #renderArea(VkRect2D) renderArea}. */
public static void nrenderArea(long struct, VkRect2D value) { memCopy(value.address(), struct + VkRenderPassBeginInfo.RENDERAREA, VkRect2D.SIZEOF); }
/** Sets the specified value to the {@code clearValueCount} field of the specified {@code struct}. */
public static void nclearValueCount(long struct, int value) { memPutInt(struct + VkRenderPassBeginInfo.CLEARVALUECOUNT, value); }
/** Unsafe version of {@link #pClearValues(VkClearValue.Buffer) pClearValues}. */
public static void npClearValues(long struct, VkClearValue.Buffer value) { memPutAddress(struct + VkRenderPassBeginInfo.PCLEARVALUES, memAddressSafe(value)); nclearValueCount(struct, value == null ? 0 : value.remaining()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
if (nclearValueCount(struct) != 0) {
check(memGetAddress(struct + VkRenderPassBeginInfo.PCLEARVALUES));
}
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for (int i = 0; i < count; i++) {
validate(array + i * SIZEOF);
}
}
// -----------------------------------
/** An array of {@link VkRenderPassBeginInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkRenderPassBeginInfo.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 VkRenderPassBeginInfo#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 VkRenderPassBeginInfo newInstance(long address) {
return new VkRenderPassBeginInfo(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkRenderPassBeginInfo.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkRenderPassBeginInfo.npNext(address()); }
/** Returns the value of the {@code renderPass} field. */
@NativeType("VkRenderPass")
public long renderPass() { return VkRenderPassBeginInfo.nrenderPass(address()); }
/** Returns the value of the {@code framebuffer} field. */
@NativeType("VkFramebuffer")
public long framebuffer() { return VkRenderPassBeginInfo.nframebuffer(address()); }
/** Returns a {@link VkRect2D} view of the {@code renderArea} field. */
public VkRect2D renderArea() { return VkRenderPassBeginInfo.nrenderArea(address()); }
/** Returns the value of the {@code clearValueCount} field. */
@NativeType("uint32_t")
public int clearValueCount() { return VkRenderPassBeginInfo.nclearValueCount(address()); }
/** Returns a {@link VkClearValue.Buffer} view of the struct array pointed to by the {@code pClearValues} field. */
@NativeType("const VkClearValue *")
public VkClearValue.Buffer pClearValues() { return VkRenderPassBeginInfo.npClearValues(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkRenderPassBeginInfo.Buffer sType(@NativeType("VkStructureType") int value) { VkRenderPassBeginInfo.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkRenderPassBeginInfo.Buffer pNext(@NativeType("const void *") long value) { VkRenderPassBeginInfo.npNext(address(), value); return this; }
/** Sets the specified value to the {@code renderPass} field. */
public VkRenderPassBeginInfo.Buffer renderPass(@NativeType("VkRenderPass") long value) { VkRenderPassBeginInfo.nrenderPass(address(), value); return this; }
/** Sets the specified value to the {@code framebuffer} field. */
public VkRenderPassBeginInfo.Buffer framebuffer(@NativeType("VkFramebuffer") long value) { VkRenderPassBeginInfo.nframebuffer(address(), value); return this; }
/** Copies the specified {@link VkRect2D} to the {@code renderArea} field. */
public VkRenderPassBeginInfo.Buffer renderArea(VkRect2D value) { VkRenderPassBeginInfo.nrenderArea(address(), value); return this; }
/** Sets the address of the specified {@link VkClearValue.Buffer} to the {@code pClearValues} field. */
public VkRenderPassBeginInfo.Buffer pClearValues(@NativeType("const VkClearValue *") VkClearValue.Buffer value) { VkRenderPassBeginInfo.npClearValues(address(), value); return this; }
}
}