Package org.lwjgl.vulkan

Class VkExtent2D

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer
    public class VkExtent2D
extends Struct
implements NativeResource
    Structure specifying a two-dimensional extent.

    Member documentation

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

    Layout

    
 struct VkExtent2D {
     uint32_t width;
     uint32_t height;
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • WIDTH, HEIGHT

        The struct member offsets.

    • Constructor Detail

      • VkExtent2D

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

      • width

        public VkExtent2D width​(int value)
        Sets the specified value to the width field.

      • height

        public VkExtent2D height​(int value)
        Sets the specified value to the height field.

      • set

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

      • set

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

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • createSafe

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

      • malloc

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

      • calloc

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

      • create

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

      • createSafe

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

      • mallocStack

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

      • callocStack

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

      • mallocStack

        public static VkExtent2D mallocStack​(MemoryStack stack)
        Returns a new VkExtent2D instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • callocStack

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

      • callocStack

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

      • callocStack

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

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