Package org.lwjgl.vulkan

Class VkFramebufferCreateInfo

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • STYPE, PNEXT, FLAGS, RENDERPASS, ATTACHMENTCOUNT, PATTACHMENTS, WIDTH, HEIGHT, LAYERS

        The struct member offsets.

    • Constructor Detail

      • VkFramebufferCreateInfo

        public VkFramebufferCreateInfo​(java.nio.ByteBuffer container)
        Creates a VkFramebufferCreateInfo instance at the current position of the specified 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.

    • Method Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • sType

        public int sType()
        the type of this structure.

      • pNext

        public long pNext()
        NULL or a pointer to a structure extending this structure.

      • flags

        public int flags()
        a bitmask of VkFramebufferCreateFlagBits

      • renderPass

        public long renderPass()
        a render pass defining what render passes the framebuffer will be compatible with. See Render Pass Compatibility for details.

      • attachmentCount

        public int attachmentCount()
        the number of attachments.

      • pAttachments

        @Nullable
public java.nio.LongBuffer pAttachments()
        a pointer to an array of VkImageView handles, each of which will be used as the corresponding attachment in a render pass instance. If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, this parameter is ignored.

      • width

        public int width()
        width, height and layers define the dimensions of the framebuffer. If the render pass uses multiview, then layers must be one and each attachment requires a number of layers that is greater than the maximum bit index set in the view mask in the subpasses in which it is used.

      • height, layers

        public int height()

public int layers()
        see width

      • set

        public VkFramebufferCreateInfo set​(int sType,
                                   long pNext,
                                   int flags,
                                   long renderPass,
                                   int attachmentCount,
                                   @Nullable
                                   java.nio.LongBuffer pAttachments,
                                   int width,
                                   int height,
                                   int layers)
        Initializes this struct with the specified values.

      • malloc

        public static VkFramebufferCreateInfo malloc()
        Returns a new VkFramebufferCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static VkFramebufferCreateInfo calloc()
        Returns a new VkFramebufferCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static VkFramebufferCreateInfo create()
        Returns a new VkFramebufferCreateInfo instance allocated with BufferUtils.

      • create

        public static VkFramebufferCreateInfo create​(long address)
        Returns a new VkFramebufferCreateInfo instance for the specified memory address.

      • malloc

        public static VkFramebufferCreateInfo malloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkFramebufferCreateInfo instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static VkFramebufferCreateInfo calloc​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkFramebufferCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • calloc

        public static VkFramebufferCreateInfo.Buffer calloc​(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
        Returns a new VkFramebufferCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().

      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().

      • nflags

        public static int nflags​(long struct)
        Unsafe version of flags().

      • nrenderPass

        public static long nrenderPass​(long struct)
        Unsafe version of renderPass().

      • nattachmentCount

        public static int nattachmentCount​(long struct)
        Unsafe version of attachmentCount().

      • npAttachments

        @Nullable
public static java.nio.LongBuffer npAttachments​(long struct)
        Unsafe version of pAttachments.

      • nwidth

        public static int nwidth​(long struct)
        Unsafe version of width().

      • nheight

        public static int nheight​(long struct)
        Unsafe version of height().

      • nlayers

        public static int nlayers​(long struct)
        Unsafe version of layers().

      • nsType

        public static void nsType​(long struct,
                          int value)
        Unsafe version of sType.

      • npNext

        public static void npNext​(long struct,
                          long value)
        Unsafe version of pNext.

      • nflags

        public static void nflags​(long struct,
                          int value)
        Unsafe version of flags.

      • nrenderPass

        public static void nrenderPass​(long struct,
                               long value)
        Unsafe version of renderPass.

      • nattachmentCount

        public static void nattachmentCount​(long struct,
                                    int value)
        Sets the specified value to the attachmentCount field of the specified struct.

      • npAttachments

        public static void npAttachments​(long struct,
                                 @Nullable
                                 java.nio.LongBuffer value)
        Unsafe version of pAttachments.

      • nwidth

        public static void nwidth​(long struct,
                          int value)
        Unsafe version of width.

      • nheight

        public static void nheight​(long struct,
                           int value)
        Unsafe version of height.

      • nlayers

        public static void nlayers​(long struct,
                           int value)
        Unsafe version of layers.