Class VulkanRenderModuleImageView.VulkanImageViewData

java.lang.Object
io.codetoil.curved_spacetime.render.vulkan.VulkanRenderModuleImageView.VulkanImageViewData
Enclosing class:
VulkanRenderModuleImageView
public static class VulkanRenderModuleImageView.VulkanImageViewData extends Object
How an image should be interpreted by a view, built up fluently.

Defaults describe the common case: a single-layer, single-mip two-dimensional image. Only format and aspectMask normally need setting.

  • Constructor Details

    • VulkanImageViewData

      public VulkanImageViewData()
      Creates view data describing a single-layer, single-mip two-dimensional image.

  • Method Details

    • aspectMask

      public VulkanRenderModuleImageView.VulkanImageViewData aspectMask(int aspectMask)
      Sets which aspect of the image the view exposes.
      Parameters:
      aspectMask - the Vulkan aspect mask, such as colour or depth
      Returns:
      this object, so calls can be chained

    • baseArrayLayer

      public VulkanRenderModuleImageView.VulkanImageViewData baseArrayLayer(int baseArrayLayer)
      Sets the first array layer the view starts at.
      Parameters:
      baseArrayLayer - the index of the first array layer
      Returns:
      this object, so calls can be chained

    • format

      public VulkanRenderModuleImageView.VulkanImageViewData format(int format)
      Sets the pixel format the image is interpreted in.
      Parameters:
      format - the Vulkan image format
      Returns:
      this object, so calls can be chained

    • layerCount

      public VulkanRenderModuleImageView.VulkanImageViewData layerCount(int layerCount)
      Sets how many array layers the view covers.
      Parameters:
      layerCount - the number of array layers
      Returns:
      this object, so calls can be chained

    • mipLevels

      public VulkanRenderModuleImageView.VulkanImageViewData mipLevels(int mipLevels)
      Sets how many mip levels the view covers.
      Parameters:
      mipLevels - the number of mip levels
      Returns:
      this object, so calls can be chained

    • viewType

      public VulkanRenderModuleImageView.VulkanImageViewData viewType(int viewType)
      Sets the dimensionality of the view.
      Parameters:
      viewType - the Vulkan image view type, such as 2D or cube
      Returns:
      this object, so calls can be chained