Package org.lwjgl.vulkan

Class VkImageSubresource

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkImageSubresource
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure specifying an image subresource.
    Valid Usage (Implicit)
    • aspectMask must be a valid combination of VkImageAspectFlagBits values
    • aspectMask must not be 0
    See Also

    VkSparseImageMemoryBind, GetImageSubresourceLayout

    Layout

    
 struct VkImageSubresource {
     VkImageAspectFlags aspectMask();
     uint32_t mipLevel();
     uint32_t arrayLayer();
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • ASPECTMASK, MIPLEVEL, ARRAYLAYER

        The struct member offsets.

    • Constructor Detail

      • VkImageSubresource

        public VkImageSubresource​(java.nio.ByteBuffer container)
        Creates a VkImageSubresource 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()
        a VkImageAspectFlags value selecting the image aspect.

      • mipLevel

        public int mipLevel()
        selects the mipmap level.

      • arrayLayer

        public int arrayLayer()
        selects the array layer.

      • set

        public VkImageSubresource set​(int aspectMask,
                              int mipLevel,
                              int arrayLayer)
        Initializes this struct with the specified values.

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • createSafe

        @Nullable
public static VkImageSubresource createSafe​(long address)
        Like create, but returns null if address is NULL.

      • createSafe

        @Nullable
public static VkImageSubresource.Buffer createSafe​(long address,
                                                   int capacity)
        Like create, but returns null if address is NULL.

      • mallocStack

        @Deprecated
public static VkImageSubresource mallocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

      • callocStack

        @Deprecated
public static VkImageSubresource callocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

      • malloc

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

      • calloc

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

      • malloc

        public static VkImageSubresource.Buffer malloc​(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
        Returns a new VkImageSubresource.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • calloc

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

      • narrayLayer

        public static int narrayLayer​(long struct)
        Unsafe version of arrayLayer().

      • 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.

      • narrayLayer

        public static void narrayLayer​(long struct,
                               int value)
        Unsafe version of arrayLayer.