All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.lwjgl.vulkan.VkPipelineRenderingCreateInfoKHR Maven / Gradle / Ivy

Go to download

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.

There is a newer version: 3.3.4
Show newest version
/*
 * 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;

/**
 * Structure specifying attachment formats.
 * 
 * 
Description
* *

When a pipeline is created without a {@code VkRenderPass}, if this structure is present in the {@code pNext} chain of {@link VkGraphicsPipelineCreateInfo}, it specifies the view mask and format of attachments used for rendering. If this structure is not specified, and the pipeline does not include a {@code VkRenderPass}, {@code viewMask} and {@code colorAttachmentCount} are 0, and {@code depthAttachmentFormat} and {@code stencilAttachmentFormat} are {@link VK10#VK_FORMAT_UNDEFINED FORMAT_UNDEFINED}. If a graphics pipeline is created with a valid {@code VkRenderPass}, parameters of this structure are ignored.

* *

If {@code depthAttachmentFormat}, {@code stencilAttachmentFormat}, or any element of {@code pColorAttachmentFormats} is {@link VK10#VK_FORMAT_UNDEFINED FORMAT_UNDEFINED}, it indicates that the corresponding attachment is unused within the render pass. Valid formats indicate that an attachment can be used - but it is still valid to set the attachment to {@code NULL} when beginning rendering.

* *
Valid Usage
* *
    *
  • If any element of {@code pColorAttachmentFormats} is not {@link VK10#VK_FORMAT_UNDEFINED FORMAT_UNDEFINED}, it must be a format with potential format features that include {@link VK10#VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT FORMAT_FEATURE_COLOR_ATTACHMENT_BIT}
  • *
  • If {@code depthAttachmentFormat} is not {@link VK10#VK_FORMAT_UNDEFINED FORMAT_UNDEFINED}, it must be a format with potential format features that include {@link VK10#VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT}
  • *
  • If {@code stencilAttachmentFormat} is not {@link VK10#VK_FORMAT_UNDEFINED FORMAT_UNDEFINED}, it must be a format with potential format features that include {@link VK10#VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT}
  • *
  • If {@code depthAttachmentFormat} is not {@link VK10#VK_FORMAT_UNDEFINED FORMAT_UNDEFINED} and {@code stencilAttachmentFormat} is not {@link VK10#VK_FORMAT_UNDEFINED FORMAT_UNDEFINED}, {@code depthAttachmentFormat} must equal {@code stencilAttachmentFormat}
  • *
  • If the {@code multiview} feature is not enabled, {@code viewMask} must be 0
  • *
  • The index of the most significant bit in {@code viewMask} must be less than {@code maxMultiviewViewCount}
  • *
* *
Valid Usage (Implicit)
* *
    *
  • {@code sType} must be {@link KHRDynamicRendering#VK_STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR}
  • *
  • If {@code colorAttachmentCount} is not 0, {@code pColorAttachmentFormats} must be a valid pointer to an array of {@code colorAttachmentCount} valid {@code VkFormat} values
  • *
  • {@code depthAttachmentFormat} must be a valid {@code VkFormat} value
  • *
  • {@code stencilAttachmentFormat} must be a valid {@code VkFormat} value
  • *
* *

Layout

* *

 * struct VkPipelineRenderingCreateInfoKHR {
 *     VkStructureType {@link #sType};
 *     void const * {@link #pNext};
 *     uint32_t {@link #viewMask};
 *     uint32_t {@link #colorAttachmentCount};
 *     VkFormat const * {@link #pColorAttachmentFormats};
 *     VkFormat {@link #depthAttachmentFormat};
 *     VkFormat {@link #stencilAttachmentFormat};
 * }
*/ public class VkPipelineRenderingCreateInfoKHR extends Struct implements NativeResource { /** The struct size in bytes. */ public static final int SIZEOF; /** The struct alignment in bytes. */ public static final int ALIGNOF; /** The struct member offsets. */ public static final int STYPE, PNEXT, VIEWMASK, COLORATTACHMENTCOUNT, PCOLORATTACHMENTFORMATS, DEPTHATTACHMENTFORMAT, STENCILATTACHMENTFORMAT; static { Layout layout = __struct( __member(4), __member(POINTER_SIZE), __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); VIEWMASK = layout.offsetof(2); COLORATTACHMENTCOUNT = layout.offsetof(3); PCOLORATTACHMENTFORMATS = layout.offsetof(4); DEPTHATTACHMENTFORMAT = layout.offsetof(5); STENCILATTACHMENTFORMAT = layout.offsetof(6); } /** * Creates a {@code VkPipelineRenderingCreateInfoKHR} 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 VkPipelineRenderingCreateInfoKHR(ByteBuffer container) { super(memAddress(container), __checkContainer(container, SIZEOF)); } @Override public int sizeof() { return SIZEOF; } /** the type of this structure. */ @NativeType("VkStructureType") public int sType() { return nsType(address()); } /** {@code NULL} or a pointer to a structure extending this structure. */ @NativeType("void const *") public long pNext() { return npNext(address()); } /** the viewMask used for rendering. */ @NativeType("uint32_t") public int viewMask() { return nviewMask(address()); } /** the number of entries in {@code pColorAttachmentFormats} */ @NativeType("uint32_t") public int colorAttachmentCount() { return ncolorAttachmentCount(address()); } /** an array of {@code VkFormat} values defining the format of color attachments used in this pipeline. */ @Nullable @NativeType("VkFormat const *") public IntBuffer pColorAttachmentFormats() { return npColorAttachmentFormats(address()); } /** a {@code VkFormat} value defining the format of the depth attachment used in this pipeline. */ @NativeType("VkFormat") public int depthAttachmentFormat() { return ndepthAttachmentFormat(address()); } /** a {@code VkFormat} value defining the format of the stencil attachment used in this pipeline. */ @NativeType("VkFormat") public int stencilAttachmentFormat() { return nstencilAttachmentFormat(address()); } /** Sets the specified value to the {@link #sType} field. */ public VkPipelineRenderingCreateInfoKHR sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; } /** Sets the {@link KHRDynamicRendering#VK_STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR} value to the {@link #sType} field. */ public VkPipelineRenderingCreateInfoKHR sType$Default() { return sType(KHRDynamicRendering.VK_STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR); } /** Sets the specified value to the {@link #pNext} field. */ public VkPipelineRenderingCreateInfoKHR pNext(@NativeType("void const *") long value) { npNext(address(), value); return this; } /** Sets the specified value to the {@link #viewMask} field. */ public VkPipelineRenderingCreateInfoKHR viewMask(@NativeType("uint32_t") int value) { nviewMask(address(), value); return this; } /** Sets the address of the specified {@link IntBuffer} to the {@link #pColorAttachmentFormats} field. */ public VkPipelineRenderingCreateInfoKHR pColorAttachmentFormats(@Nullable @NativeType("VkFormat const *") IntBuffer value) { npColorAttachmentFormats(address(), value); return this; } /** Sets the specified value to the {@link #depthAttachmentFormat} field. */ public VkPipelineRenderingCreateInfoKHR depthAttachmentFormat(@NativeType("VkFormat") int value) { ndepthAttachmentFormat(address(), value); return this; } /** Sets the specified value to the {@link #stencilAttachmentFormat} field. */ public VkPipelineRenderingCreateInfoKHR stencilAttachmentFormat(@NativeType("VkFormat") int value) { nstencilAttachmentFormat(address(), value); return this; } /** Initializes this struct with the specified values. */ public VkPipelineRenderingCreateInfoKHR set( int sType, long pNext, int viewMask, @Nullable IntBuffer pColorAttachmentFormats, int depthAttachmentFormat, int stencilAttachmentFormat ) { sType(sType); pNext(pNext); viewMask(viewMask); pColorAttachmentFormats(pColorAttachmentFormats); depthAttachmentFormat(depthAttachmentFormat); stencilAttachmentFormat(stencilAttachmentFormat); return this; } /** * Copies the specified struct data to this struct. * * @param src the source struct * * @return this struct */ public VkPipelineRenderingCreateInfoKHR set(VkPipelineRenderingCreateInfoKHR src) { memCopy(src.address(), address(), SIZEOF); return this; } // ----------------------------------- /** Returns a new {@code VkPipelineRenderingCreateInfoKHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */ public static VkPipelineRenderingCreateInfoKHR malloc() { return wrap(VkPipelineRenderingCreateInfoKHR.class, nmemAllocChecked(SIZEOF)); } /** Returns a new {@code VkPipelineRenderingCreateInfoKHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */ public static VkPipelineRenderingCreateInfoKHR calloc() { return wrap(VkPipelineRenderingCreateInfoKHR.class, nmemCallocChecked(1, SIZEOF)); } /** Returns a new {@code VkPipelineRenderingCreateInfoKHR} instance allocated with {@link BufferUtils}. */ public static VkPipelineRenderingCreateInfoKHR create() { ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF); return wrap(VkPipelineRenderingCreateInfoKHR.class, memAddress(container), container); } /** Returns a new {@code VkPipelineRenderingCreateInfoKHR} instance for the specified memory address. */ public static VkPipelineRenderingCreateInfoKHR create(long address) { return wrap(VkPipelineRenderingCreateInfoKHR.class, address); } /** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */ @Nullable public static VkPipelineRenderingCreateInfoKHR createSafe(long address) { return address == NULL ? null : wrap(VkPipelineRenderingCreateInfoKHR.class, address); } /** * Returns a new {@link VkPipelineRenderingCreateInfoKHR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. * * @param capacity the buffer capacity */ public static VkPipelineRenderingCreateInfoKHR.Buffer malloc(int capacity) { return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity); } /** * Returns a new {@link VkPipelineRenderingCreateInfoKHR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. * * @param capacity the buffer capacity */ public static VkPipelineRenderingCreateInfoKHR.Buffer calloc(int capacity) { return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity); } /** * Returns a new {@link VkPipelineRenderingCreateInfoKHR.Buffer} instance allocated with {@link BufferUtils}. * * @param capacity the buffer capacity */ public static VkPipelineRenderingCreateInfoKHR.Buffer create(int capacity) { ByteBuffer container = __create(capacity, SIZEOF); return wrap(Buffer.class, memAddress(container), capacity, container); } /** * Create a {@link VkPipelineRenderingCreateInfoKHR.Buffer} instance at the specified memory. * * @param address the memory address * @param capacity the buffer capacity */ public static VkPipelineRenderingCreateInfoKHR.Buffer create(long address, int capacity) { return wrap(Buffer.class, address, capacity); } /** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */ @Nullable public static VkPipelineRenderingCreateInfoKHR.Buffer createSafe(long address, int capacity) { return address == NULL ? null : wrap(Buffer.class, address, capacity); } /** * Returns a new {@code VkPipelineRenderingCreateInfoKHR} instance allocated on the specified {@link MemoryStack}. * * @param stack the stack from which to allocate */ public static VkPipelineRenderingCreateInfoKHR malloc(MemoryStack stack) { return wrap(VkPipelineRenderingCreateInfoKHR.class, stack.nmalloc(ALIGNOF, SIZEOF)); } /** * Returns a new {@code VkPipelineRenderingCreateInfoKHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero. * * @param stack the stack from which to allocate */ public static VkPipelineRenderingCreateInfoKHR calloc(MemoryStack stack) { return wrap(VkPipelineRenderingCreateInfoKHR.class, stack.ncalloc(ALIGNOF, 1, SIZEOF)); } /** * Returns a new {@link VkPipelineRenderingCreateInfoKHR.Buffer} instance allocated on the specified {@link MemoryStack}. * * @param stack the stack from which to allocate * @param capacity the buffer capacity */ public static VkPipelineRenderingCreateInfoKHR.Buffer malloc(int capacity, MemoryStack stack) { return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity); } /** * Returns a new {@link VkPipelineRenderingCreateInfoKHR.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 VkPipelineRenderingCreateInfoKHR.Buffer calloc(int capacity, MemoryStack stack) { return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity); } // ----------------------------------- /** Unsafe version of {@link #sType}. */ public static int nsType(long struct) { return UNSAFE.getInt(null, struct + VkPipelineRenderingCreateInfoKHR.STYPE); } /** Unsafe version of {@link #pNext}. */ public static long npNext(long struct) { return memGetAddress(struct + VkPipelineRenderingCreateInfoKHR.PNEXT); } /** Unsafe version of {@link #viewMask}. */ public static int nviewMask(long struct) { return UNSAFE.getInt(null, struct + VkPipelineRenderingCreateInfoKHR.VIEWMASK); } /** Unsafe version of {@link #colorAttachmentCount}. */ public static int ncolorAttachmentCount(long struct) { return UNSAFE.getInt(null, struct + VkPipelineRenderingCreateInfoKHR.COLORATTACHMENTCOUNT); } /** Unsafe version of {@link #pColorAttachmentFormats() pColorAttachmentFormats}. */ @Nullable public static IntBuffer npColorAttachmentFormats(long struct) { return memIntBufferSafe(memGetAddress(struct + VkPipelineRenderingCreateInfoKHR.PCOLORATTACHMENTFORMATS), ncolorAttachmentCount(struct)); } /** Unsafe version of {@link #depthAttachmentFormat}. */ public static int ndepthAttachmentFormat(long struct) { return UNSAFE.getInt(null, struct + VkPipelineRenderingCreateInfoKHR.DEPTHATTACHMENTFORMAT); } /** Unsafe version of {@link #stencilAttachmentFormat}. */ public static int nstencilAttachmentFormat(long struct) { return UNSAFE.getInt(null, struct + VkPipelineRenderingCreateInfoKHR.STENCILATTACHMENTFORMAT); } /** Unsafe version of {@link #sType(int) sType}. */ public static void nsType(long struct, int value) { UNSAFE.putInt(null, struct + VkPipelineRenderingCreateInfoKHR.STYPE, value); } /** Unsafe version of {@link #pNext(long) pNext}. */ public static void npNext(long struct, long value) { memPutAddress(struct + VkPipelineRenderingCreateInfoKHR.PNEXT, value); } /** Unsafe version of {@link #viewMask(int) viewMask}. */ public static void nviewMask(long struct, int value) { UNSAFE.putInt(null, struct + VkPipelineRenderingCreateInfoKHR.VIEWMASK, value); } /** Sets the specified value to the {@code colorAttachmentCount} field of the specified {@code struct}. */ public static void ncolorAttachmentCount(long struct, int value) { UNSAFE.putInt(null, struct + VkPipelineRenderingCreateInfoKHR.COLORATTACHMENTCOUNT, value); } /** Unsafe version of {@link #pColorAttachmentFormats(IntBuffer) pColorAttachmentFormats}. */ public static void npColorAttachmentFormats(long struct, @Nullable IntBuffer value) { memPutAddress(struct + VkPipelineRenderingCreateInfoKHR.PCOLORATTACHMENTFORMATS, memAddressSafe(value)); ncolorAttachmentCount(struct, value == null ? 0 : value.remaining()); } /** Unsafe version of {@link #depthAttachmentFormat(int) depthAttachmentFormat}. */ public static void ndepthAttachmentFormat(long struct, int value) { UNSAFE.putInt(null, struct + VkPipelineRenderingCreateInfoKHR.DEPTHATTACHMENTFORMAT, value); } /** Unsafe version of {@link #stencilAttachmentFormat(int) stencilAttachmentFormat}. */ public static void nstencilAttachmentFormat(long struct, int value) { UNSAFE.putInt(null, struct + VkPipelineRenderingCreateInfoKHR.STENCILATTACHMENTFORMAT, value); } /** * Validates pointer members that should not be {@code NULL}. * * @param struct the struct to validate */ public static void validate(long struct) { if (ncolorAttachmentCount(struct) != 0) { check(memGetAddress(struct + VkPipelineRenderingCreateInfoKHR.PCOLORATTACHMENTFORMATS)); } } // ----------------------------------- /** An array of {@link VkPipelineRenderingCreateInfoKHR} structs. */ public static class Buffer extends StructBuffer implements NativeResource { private static final VkPipelineRenderingCreateInfoKHR ELEMENT_FACTORY = VkPipelineRenderingCreateInfoKHR.create(-1L); /** * Creates a new {@code VkPipelineRenderingCreateInfoKHR.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 VkPipelineRenderingCreateInfoKHR#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 VkPipelineRenderingCreateInfoKHR getElementFactory() { return ELEMENT_FACTORY; } /** @return the value of the {@link VkPipelineRenderingCreateInfoKHR#sType} field. */ @NativeType("VkStructureType") public int sType() { return VkPipelineRenderingCreateInfoKHR.nsType(address()); } /** @return the value of the {@link VkPipelineRenderingCreateInfoKHR#pNext} field. */ @NativeType("void const *") public long pNext() { return VkPipelineRenderingCreateInfoKHR.npNext(address()); } /** @return the value of the {@link VkPipelineRenderingCreateInfoKHR#viewMask} field. */ @NativeType("uint32_t") public int viewMask() { return VkPipelineRenderingCreateInfoKHR.nviewMask(address()); } /** @return the value of the {@link VkPipelineRenderingCreateInfoKHR#colorAttachmentCount} field. */ @NativeType("uint32_t") public int colorAttachmentCount() { return VkPipelineRenderingCreateInfoKHR.ncolorAttachmentCount(address()); } /** @return a {@link IntBuffer} view of the data pointed to by the {@link VkPipelineRenderingCreateInfoKHR#pColorAttachmentFormats} field. */ @Nullable @NativeType("VkFormat const *") public IntBuffer pColorAttachmentFormats() { return VkPipelineRenderingCreateInfoKHR.npColorAttachmentFormats(address()); } /** @return the value of the {@link VkPipelineRenderingCreateInfoKHR#depthAttachmentFormat} field. */ @NativeType("VkFormat") public int depthAttachmentFormat() { return VkPipelineRenderingCreateInfoKHR.ndepthAttachmentFormat(address()); } /** @return the value of the {@link VkPipelineRenderingCreateInfoKHR#stencilAttachmentFormat} field. */ @NativeType("VkFormat") public int stencilAttachmentFormat() { return VkPipelineRenderingCreateInfoKHR.nstencilAttachmentFormat(address()); } /** Sets the specified value to the {@link VkPipelineRenderingCreateInfoKHR#sType} field. */ public VkPipelineRenderingCreateInfoKHR.Buffer sType(@NativeType("VkStructureType") int value) { VkPipelineRenderingCreateInfoKHR.nsType(address(), value); return this; } /** Sets the {@link KHRDynamicRendering#VK_STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR} value to the {@link VkPipelineRenderingCreateInfoKHR#sType} field. */ public VkPipelineRenderingCreateInfoKHR.Buffer sType$Default() { return sType(KHRDynamicRendering.VK_STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR); } /** Sets the specified value to the {@link VkPipelineRenderingCreateInfoKHR#pNext} field. */ public VkPipelineRenderingCreateInfoKHR.Buffer pNext(@NativeType("void const *") long value) { VkPipelineRenderingCreateInfoKHR.npNext(address(), value); return this; } /** Sets the specified value to the {@link VkPipelineRenderingCreateInfoKHR#viewMask} field. */ public VkPipelineRenderingCreateInfoKHR.Buffer viewMask(@NativeType("uint32_t") int value) { VkPipelineRenderingCreateInfoKHR.nviewMask(address(), value); return this; } /** Sets the address of the specified {@link IntBuffer} to the {@link VkPipelineRenderingCreateInfoKHR#pColorAttachmentFormats} field. */ public VkPipelineRenderingCreateInfoKHR.Buffer pColorAttachmentFormats(@Nullable @NativeType("VkFormat const *") IntBuffer value) { VkPipelineRenderingCreateInfoKHR.npColorAttachmentFormats(address(), value); return this; } /** Sets the specified value to the {@link VkPipelineRenderingCreateInfoKHR#depthAttachmentFormat} field. */ public VkPipelineRenderingCreateInfoKHR.Buffer depthAttachmentFormat(@NativeType("VkFormat") int value) { VkPipelineRenderingCreateInfoKHR.ndepthAttachmentFormat(address(), value); return this; } /** Sets the specified value to the {@link VkPipelineRenderingCreateInfoKHR#stencilAttachmentFormat} field. */ public VkPipelineRenderingCreateInfoKHR.Buffer stencilAttachmentFormat(@NativeType("VkFormat") int value) { VkPipelineRenderingCreateInfoKHR.nstencilAttachmentFormat(address(), value); return this; } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy