Class VkExtent3D

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

    public class VkExtent3D
    extends Struct
    implements NativeResource
    Structure specifying a three-dimensional extent.

    Member documentation

    • width – the width of the extent.
    • height – the height of the extent.
    • depth – the depth of the extent.

    Layout

    
     struct VkExtent3D {
         uint32_t width;
         uint32_t height;
         uint32_t depth;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • WIDTH, HEIGHT, DEPTH

        The struct member offsets.
    • Constructor Detail

      • VkExtent3D

        public VkExtent3D​(java.nio.ByteBuffer container)
        Creates a VkExtent3D 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • width

        public int width()
        Returns the value of the width field.
      • height

        public int height()
        Returns the value of the height field.
      • depth

        public int depth()
        Returns the value of the depth field.
      • width

        public VkExtent3D width​(int value)
        Sets the specified value to the width field.
      • height

        public VkExtent3D height​(int value)
        Sets the specified value to the height field.
      • depth

        public VkExtent3D depth​(int value)
        Sets the specified value to the depth field.
      • set

        public VkExtent3D set​(int width,
                              int height,
                              int depth)
        Initializes this struct with the specified values.
      • set

        public VkExtent3D set​(VkExtent3D src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct
      • malloc

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

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

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

        public static VkExtent3D.Buffer malloc​(int capacity)
        Returns a new VkExtent3D.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • calloc

        public static VkExtent3D.Buffer calloc​(int capacity)
        Returns a new VkExtent3D.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • create

        public static VkExtent3D.Buffer create​(long address,
                                               int capacity)
        Create a VkExtent3D.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity
      • createSafe

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

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

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

        public static VkExtent3D.Buffer callocStack​(int capacity)
        Returns a new VkExtent3D.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • callocStack

        public static VkExtent3D.Buffer callocStack​(int capacity,
                                                    MemoryStack stack)
        Returns a new VkExtent3D.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
      • nwidth

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

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

        public static int ndepth​(long struct)
        Unsafe version of depth().
      • 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.
      • ndepth

        public static void ndepth​(long struct,
                                  int value)
        Unsafe version of depth.