Class VkExtent3D

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


    public class VkExtent3D
    extends Struct
    Khronos Reference Page
    Vulkan Specification

    Describes the size of a rectangular region of pixels within a three-dimensional image or framebuffer.

    Member documentation

    • width – the region width
    • height – the region height
    • depth – the region depth

    Layout

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

      • SIZEOF

        public static final int SIZEOF
        The struct size in bytes.
    • 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 the 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.
      • nset

        public VkExtent3D nset(long struct)
        Unsafe version of set.
      • 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 or null if the 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
      • 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
      • 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