org.lwjgl.vulkan.VkCommandBufferInheritanceInfo 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 command buffer inheritance info.
*
* Valid Usage
*
*
* - If the inherited queries feature is not enabled, {@code occlusionQueryEnable} must be {@link VK10#VK_FALSE FALSE}
* - If the inherited queries feature is enabled, {@code queryFlags} must be a valid combination of {@code VkQueryControlFlagBits} values
* - If the pipeline statistics queries feature is not enabled, {@code pipelineStatistics} must be 0
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK10#VK_STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO}
* - {@code pNext} must be {@code NULL}
* - Both of {@code framebuffer}, and {@code renderPass} that are valid handles must have been created, allocated, or retrieved from the same {@code VkDevice}
*
*
* See Also
*
* {@link VkCommandBufferBeginInfo}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code renderPass} – a {@code VkRenderPass} object defining which render passes the {@code VkCommandBuffer} will be compatible with and can be executed within. If the {@code VkCommandBuffer} will not be executed within a render pass instance, {@code renderPass} is ignored.
* - {@code subpass} – the index of the subpass within the render pass instance that the {@code VkCommandBuffer} will be executed within. If the {@code VkCommandBuffer} will not be executed within a render pass instance, {@code subpass} is ignored.
* - {@code framebuffer} – optionally refers to the {@code VkFramebuffer} object that the {@code VkCommandBuffer} will be rendering to if it is executed within a render pass instance. It can be {@link VK10#VK_NULL_HANDLE NULL_HANDLE} if the framebuffer is not known, or if the {@code VkCommandBuffer} will not be executed within a render pass instance.
*
*
Note
*
* Specifying the exact framebuffer that the secondary command buffer will be executed with may result in better performance at command buffer execution time.
*
* - {@code occlusionQueryEnable} – indicates whether the command buffer can be executed while an occlusion query is active in the primary command buffer. If this is {@link VK10#VK_TRUE TRUE}, then this command buffer can be executed whether the primary command buffer has an occlusion query active or not. If this is {@link VK10#VK_FALSE FALSE}, then the primary command buffer must not have an occlusion query active.
* - {@code queryFlags} – indicates the query flags that can be used by an active occlusion query in the primary command buffer when this secondary command buffer is executed. If this value includes the {@link VK10#VK_QUERY_CONTROL_PRECISE_BIT QUERY_CONTROL_PRECISE_BIT} bit, then the active query can return boolean results or actual sample counts. If this bit is not set, then the active query must not use the {@link VK10#VK_QUERY_CONTROL_PRECISE_BIT QUERY_CONTROL_PRECISE_BIT} bit.
* - {@code pipelineStatistics} – a bitmask of {@code VkQueryPipelineStatisticFlagBits} specifying the set of pipeline statistics that can be counted by an active query in the primary command buffer when this secondary command buffer is executed. If this value includes a given bit, then this command buffer can be executed whether the primary command buffer has a pipeline statistics query active that includes this bit or not. If this value excludes a given bit, then the active pipeline statistics query must not be from a query pool that counts that statistic.
*
*
* Layout
*
*
* struct VkCommandBufferInheritanceInfo {
* VkStructureType sType;
* const void * pNext;
* VkRenderPass renderPass;
* uint32_t subpass;
* VkFramebuffer framebuffer;
* VkBool32 occlusionQueryEnable;
* VkQueryControlFlags queryFlags;
* VkQueryPipelineStatisticFlags pipelineStatistics;
* }The created instance holds a strong reference to the container object.
*/
public VkCommandBufferInheritanceInfo(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 subpass} field. */
@NativeType("uint32_t")
public int subpass() { return nsubpass(address()); }
/** Returns the value of the {@code framebuffer} field. */
@NativeType("VkFramebuffer")
public long framebuffer() { return nframebuffer(address()); }
/** Returns the value of the {@code occlusionQueryEnable} field. */
@NativeType("VkBool32")
public boolean occlusionQueryEnable() { return nocclusionQueryEnable(address()) != 0; }
/** Returns the value of the {@code queryFlags} field. */
@NativeType("VkQueryControlFlags")
public int queryFlags() { return nqueryFlags(address()); }
/** Returns the value of the {@code pipelineStatistics} field. */
@NativeType("VkQueryPipelineStatisticFlags")
public int pipelineStatistics() { return npipelineStatistics(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkCommandBufferInheritanceInfo sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkCommandBufferInheritanceInfo pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code renderPass} field. */
public VkCommandBufferInheritanceInfo renderPass(@NativeType("VkRenderPass") long value) { nrenderPass(address(), value); return this; }
/** Sets the specified value to the {@code subpass} field. */
public VkCommandBufferInheritanceInfo subpass(@NativeType("uint32_t") int value) { nsubpass(address(), value); return this; }
/** Sets the specified value to the {@code framebuffer} field. */
public VkCommandBufferInheritanceInfo framebuffer(@NativeType("VkFramebuffer") long value) { nframebuffer(address(), value); return this; }
/** Sets the specified value to the {@code occlusionQueryEnable} field. */
public VkCommandBufferInheritanceInfo occlusionQueryEnable(@NativeType("VkBool32") boolean value) { nocclusionQueryEnable(address(), value ? 1 : 0); return this; }
/** Sets the specified value to the {@code queryFlags} field. */
public VkCommandBufferInheritanceInfo queryFlags(@NativeType("VkQueryControlFlags") int value) { nqueryFlags(address(), value); return this; }
/** Sets the specified value to the {@code pipelineStatistics} field. */
public VkCommandBufferInheritanceInfo pipelineStatistics(@NativeType("VkQueryPipelineStatisticFlags") int value) { npipelineStatistics(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkCommandBufferInheritanceInfo set(
int sType,
long pNext,
long renderPass,
int subpass,
long framebuffer,
boolean occlusionQueryEnable,
int queryFlags,
int pipelineStatistics
) {
sType(sType);
pNext(pNext);
renderPass(renderPass);
subpass(subpass);
framebuffer(framebuffer);
occlusionQueryEnable(occlusionQueryEnable);
queryFlags(queryFlags);
pipelineStatistics(pipelineStatistics);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkCommandBufferInheritanceInfo set(VkCommandBufferInheritanceInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkCommandBufferInheritanceInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkCommandBufferInheritanceInfo malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkCommandBufferInheritanceInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkCommandBufferInheritanceInfo calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkCommandBufferInheritanceInfo} instance allocated with {@link BufferUtils}. */
public static VkCommandBufferInheritanceInfo create() {
return new VkCommandBufferInheritanceInfo(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkCommandBufferInheritanceInfo} instance for the specified memory address. */
public static VkCommandBufferInheritanceInfo create(long address) {
return new VkCommandBufferInheritanceInfo(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkCommandBufferInheritanceInfo createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkCommandBufferInheritanceInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkCommandBufferInheritanceInfo.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkCommandBufferInheritanceInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkCommandBufferInheritanceInfo.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkCommandBufferInheritanceInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkCommandBufferInheritanceInfo.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkCommandBufferInheritanceInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkCommandBufferInheritanceInfo.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 VkCommandBufferInheritanceInfo.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkCommandBufferInheritanceInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VkCommandBufferInheritanceInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkCommandBufferInheritanceInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkCommandBufferInheritanceInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkCommandBufferInheritanceInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkCommandBufferInheritanceInfo mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkCommandBufferInheritanceInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkCommandBufferInheritanceInfo callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkCommandBufferInheritanceInfo.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkCommandBufferInheritanceInfo.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkCommandBufferInheritanceInfo.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkCommandBufferInheritanceInfo.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkCommandBufferInheritanceInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkCommandBufferInheritanceInfo.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkCommandBufferInheritanceInfo.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 VkCommandBufferInheritanceInfo.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 + VkCommandBufferInheritanceInfo.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkCommandBufferInheritanceInfo.PNEXT); }
/** Unsafe version of {@link #renderPass}. */
public static long nrenderPass(long struct) { return memGetLong(struct + VkCommandBufferInheritanceInfo.RENDERPASS); }
/** Unsafe version of {@link #subpass}. */
public static int nsubpass(long struct) { return memGetInt(struct + VkCommandBufferInheritanceInfo.SUBPASS); }
/** Unsafe version of {@link #framebuffer}. */
public static long nframebuffer(long struct) { return memGetLong(struct + VkCommandBufferInheritanceInfo.FRAMEBUFFER); }
/** Unsafe version of {@link #occlusionQueryEnable}. */
public static int nocclusionQueryEnable(long struct) { return memGetInt(struct + VkCommandBufferInheritanceInfo.OCCLUSIONQUERYENABLE); }
/** Unsafe version of {@link #queryFlags}. */
public static int nqueryFlags(long struct) { return memGetInt(struct + VkCommandBufferInheritanceInfo.QUERYFLAGS); }
/** Unsafe version of {@link #pipelineStatistics}. */
public static int npipelineStatistics(long struct) { return memGetInt(struct + VkCommandBufferInheritanceInfo.PIPELINESTATISTICS); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkCommandBufferInheritanceInfo.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkCommandBufferInheritanceInfo.PNEXT, value); }
/** Unsafe version of {@link #renderPass(long) renderPass}. */
public static void nrenderPass(long struct, long value) { memPutLong(struct + VkCommandBufferInheritanceInfo.RENDERPASS, value); }
/** Unsafe version of {@link #subpass(int) subpass}. */
public static void nsubpass(long struct, int value) { memPutInt(struct + VkCommandBufferInheritanceInfo.SUBPASS, value); }
/** Unsafe version of {@link #framebuffer(long) framebuffer}. */
public static void nframebuffer(long struct, long value) { memPutLong(struct + VkCommandBufferInheritanceInfo.FRAMEBUFFER, value); }
/** Unsafe version of {@link #occlusionQueryEnable(boolean) occlusionQueryEnable}. */
public static void nocclusionQueryEnable(long struct, int value) { memPutInt(struct + VkCommandBufferInheritanceInfo.OCCLUSIONQUERYENABLE, value); }
/** Unsafe version of {@link #queryFlags(int) queryFlags}. */
public static void nqueryFlags(long struct, int value) { memPutInt(struct + VkCommandBufferInheritanceInfo.QUERYFLAGS, value); }
/** Unsafe version of {@link #pipelineStatistics(int) pipelineStatistics}. */
public static void npipelineStatistics(long struct, int value) { memPutInt(struct + VkCommandBufferInheritanceInfo.PIPELINESTATISTICS, value); }
// -----------------------------------
/** An array of {@link VkCommandBufferInheritanceInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkCommandBufferInheritanceInfo.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 VkCommandBufferInheritanceInfo#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 VkCommandBufferInheritanceInfo newInstance(long address) {
return new VkCommandBufferInheritanceInfo(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkCommandBufferInheritanceInfo.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkCommandBufferInheritanceInfo.npNext(address()); }
/** Returns the value of the {@code renderPass} field. */
@NativeType("VkRenderPass")
public long renderPass() { return VkCommandBufferInheritanceInfo.nrenderPass(address()); }
/** Returns the value of the {@code subpass} field. */
@NativeType("uint32_t")
public int subpass() { return VkCommandBufferInheritanceInfo.nsubpass(address()); }
/** Returns the value of the {@code framebuffer} field. */
@NativeType("VkFramebuffer")
public long framebuffer() { return VkCommandBufferInheritanceInfo.nframebuffer(address()); }
/** Returns the value of the {@code occlusionQueryEnable} field. */
@NativeType("VkBool32")
public boolean occlusionQueryEnable() { return VkCommandBufferInheritanceInfo.nocclusionQueryEnable(address()) != 0; }
/** Returns the value of the {@code queryFlags} field. */
@NativeType("VkQueryControlFlags")
public int queryFlags() { return VkCommandBufferInheritanceInfo.nqueryFlags(address()); }
/** Returns the value of the {@code pipelineStatistics} field. */
@NativeType("VkQueryPipelineStatisticFlags")
public int pipelineStatistics() { return VkCommandBufferInheritanceInfo.npipelineStatistics(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkCommandBufferInheritanceInfo.Buffer sType(@NativeType("VkStructureType") int value) { VkCommandBufferInheritanceInfo.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkCommandBufferInheritanceInfo.Buffer pNext(@NativeType("const void *") long value) { VkCommandBufferInheritanceInfo.npNext(address(), value); return this; }
/** Sets the specified value to the {@code renderPass} field. */
public VkCommandBufferInheritanceInfo.Buffer renderPass(@NativeType("VkRenderPass") long value) { VkCommandBufferInheritanceInfo.nrenderPass(address(), value); return this; }
/** Sets the specified value to the {@code subpass} field. */
public VkCommandBufferInheritanceInfo.Buffer subpass(@NativeType("uint32_t") int value) { VkCommandBufferInheritanceInfo.nsubpass(address(), value); return this; }
/** Sets the specified value to the {@code framebuffer} field. */
public VkCommandBufferInheritanceInfo.Buffer framebuffer(@NativeType("VkFramebuffer") long value) { VkCommandBufferInheritanceInfo.nframebuffer(address(), value); return this; }
/** Sets the specified value to the {@code occlusionQueryEnable} field. */
public VkCommandBufferInheritanceInfo.Buffer occlusionQueryEnable(@NativeType("VkBool32") boolean value) { VkCommandBufferInheritanceInfo.nocclusionQueryEnable(address(), value ? 1 : 0); return this; }
/** Sets the specified value to the {@code queryFlags} field. */
public VkCommandBufferInheritanceInfo.Buffer queryFlags(@NativeType("VkQueryControlFlags") int value) { VkCommandBufferInheritanceInfo.nqueryFlags(address(), value); return this; }
/** Sets the specified value to the {@code pipelineStatistics} field. */
public VkCommandBufferInheritanceInfo.Buffer pipelineStatistics(@NativeType("VkQueryPipelineStatisticFlags") int value) { VkCommandBufferInheritanceInfo.npipelineStatistics(address(), value); return this; }
}
}