Package org.lwjgl.vulkan

Class VkFramebufferCreateInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkFramebufferCreateInfo>
org.lwjgl.vulkan.VkFramebufferCreateInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkFramebufferCreateInfo extends org.lwjgl.system.Struct<VkFramebufferCreateInfo> implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created framebuffer.
Description

It is legal for a subpass to use no color or depth/stencil attachments, either because it has no attachment references or because all of them are ATTACHMENT_UNUSED. This kind of subpass can use shader side effects such as image stores and atomics to produce an output. In this case, the subpass continues to use the width, height, and layers of the framebuffer to define the dimensions of the rendering area, and the rasterizationSamples from each pipeline’s VkPipelineMultisampleStateCreateInfo to define the number of samples used in rasterization; however, if VkPhysicalDeviceFeatures::variableMultisampleRate is FALSE, then all pipelines to be bound with the subpass must have the same value for VkPipelineMultisampleStateCreateInfo::rasterizationSamples. In all such cases, rasterizationSamples must be a valid VkSampleCountFlagBits value that is set in VkPhysicalDeviceLimits::framebufferNoAttachmentsSampleCounts.

Valid Usage
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO
  • pNext must be NULL or a pointer to a valid instance of VkFramebufferAttachmentsCreateInfo
  • The sType value of each struct in the pNext chain must be unique
  • flags must be a valid combination of VkFramebufferCreateFlagBits values
  • renderPass must be a valid VkRenderPass handle
  • Both of renderPass, and the elements of pAttachments that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice
See Also

CreateFramebuffer

Layout


 struct VkFramebufferCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkFramebufferCreateFlags flags();
     VkRenderPass renderPass();
     uint32_t attachmentCount();
     VkImageView const * pAttachments();
     uint32_t width();
     uint32_t height();
     uint32_t layers();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • FLAGS

      public static final int FLAGS
      The struct member offsets.

    • RENDERPASS

      public static final int RENDERPASS
      The struct member offsets.

    • ATTACHMENTCOUNT

      public static final int ATTACHMENTCOUNT
      The struct member offsets.

    • PATTACHMENTS

      public static final int PATTACHMENTS
      The struct member offsets.

    • WIDTH

      public static final int WIDTH
      The struct member offsets.

    • HEIGHT

      public static final int HEIGHT
      The struct member offsets.

    • LAYERS

      public static final int LAYERS
      The struct member offsets.

  • Constructor Details

    • VkFramebufferCreateInfo

      public VkFramebufferCreateInfo(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 Details