Class VkImageSubresourceLayers

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class VkImageSubresourceLayers
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying an image subresource layers.
    Valid Usage
    Valid Usage (Implicit)
    • aspectMask must be a valid combination of VkImageAspectFlagBits values
    • aspectMask must not be 0
    See Also

    VkBufferImageCopy, VkImageBlit, VkImageCopy, VkImageResolve

    Member documentation

    • aspectMask – a combination of VkImageAspectFlagBits, selecting the color, depth and/or stencil aspects to be copied.
    • mipLevel – the mipmap level to copy from.
    • baseArrayLayerbaseArrayLayer and layerCount are the starting layer and number of layers to copy.
    • layerCount – see baseArrayLayer

    Layout

    
     struct VkImageSubresourceLayers {
         VkImageAspectFlags aspectMask;
         uint32_t mipLevel;
         uint32_t baseArrayLayer;
         uint32_t layerCount;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • ASPECTMASK, MIPLEVEL, BASEARRAYLAYER, LAYERCOUNT

        The struct member offsets.
    • Constructor Detail

      • VkImageSubresourceLayers

        public VkImageSubresourceLayers​(java.nio.ByteBuffer container)
        Creates a VkImageSubresourceLayers 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
      • aspectMask

        public int aspectMask()
        Returns the value of the aspectMask field.
      • mipLevel

        public int mipLevel()
        Returns the value of the mipLevel field.
      • baseArrayLayer

        public int baseArrayLayer()
        Returns the value of the baseArrayLayer field.
      • layerCount

        public int layerCount()
        Returns the value of the layerCount field.
      • aspectMask

        public VkImageSubresourceLayers aspectMask​(int value)
        Sets the specified value to the aspectMask field.
      • baseArrayLayer

        public VkImageSubresourceLayers baseArrayLayer​(int value)
        Sets the specified value to the baseArrayLayer field.
      • layerCount

        public VkImageSubresourceLayers layerCount​(int value)
        Sets the specified value to the layerCount field.
      • set

        public VkImageSubresourceLayers set​(int aspectMask,
                                            int mipLevel,
                                            int baseArrayLayer,
                                            int layerCount)
        Initializes this struct with the specified values.
      • malloc

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

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

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

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

        public static VkImageSubresourceLayers mallocStack()
        Returns a new VkImageSubresourceLayers instance allocated on the thread-local MemoryStack.
      • callocStack

        public static VkImageSubresourceLayers callocStack()
        Returns a new VkImageSubresourceLayers instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

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

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

        public static VkImageSubresourceLayers.Buffer callocStack​(int capacity,
                                                                  org.lwjgl.system.MemoryStack stack)
        Returns a new VkImageSubresourceLayers.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
      • naspectMask

        public static int naspectMask​(long struct)
        Unsafe version of aspectMask().
      • nmipLevel

        public static int nmipLevel​(long struct)
        Unsafe version of mipLevel().
      • nbaseArrayLayer

        public static int nbaseArrayLayer​(long struct)
        Unsafe version of baseArrayLayer().
      • nlayerCount

        public static int nlayerCount​(long struct)
        Unsafe version of layerCount().
      • naspectMask

        public static void naspectMask​(long struct,
                                       int value)
        Unsafe version of aspectMask.
      • nmipLevel

        public static void nmipLevel​(long struct,
                                     int value)
        Unsafe version of mipLevel.
      • nbaseArrayLayer

        public static void nbaseArrayLayer​(long struct,
                                           int value)
        Unsafe version of baseArrayLayer.
      • nlayerCount

        public static void nlayerCount​(long struct,
                                       int value)
        Unsafe version of layerCount.