Package org.lwjgl.vulkan

Class VkOffset3D

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer
    public class VkOffset3D
extends Struct
implements NativeResource
    Structure specifying a three-dimensional offset.

    Member documentation

    • x – the x offset.
    • y – the y offset.
    • z – the z offset.

    Layout

    
 struct VkOffset3D {
     int32_t x;
     int32_t y;
     int32_t z;
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • X, Y, Z

        The struct member offsets.

    • Constructor Detail

      • VkOffset3D

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

      • x

        public int x()
        Returns the value of the x field.

      • y

        public int y()
        Returns the value of the y field.

      • z

        public int z()
        Returns the value of the z field.

      • x

        public VkOffset3D x​(int value)
        Sets the specified value to the x field.

      • y

        public VkOffset3D y​(int value)
        Sets the specified value to the y field.

      • z

        public VkOffset3D z​(int value)
        Sets the specified value to the z field.

      • set

        public VkOffset3D set​(int x,
                      int y,
                      int z)
        Initializes this struct with the specified values.

      • set

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

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • createSafe

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

      • malloc

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

      • calloc

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

      • create

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

      • createSafe

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

      • mallocStack

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

      • callocStack

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

      • mallocStack

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

      • callocStack

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

      • callocStack

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

      • callocStack

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

      • nx

        public static int nx​(long struct)
        Unsafe version of x().

      • ny

        public static int ny​(long struct)
        Unsafe version of y().

      • nz

        public static int nz​(long struct)
        Unsafe version of z().

      • nx

        public static void nx​(long struct,
                      int value)
        Unsafe version of x.

      • ny

        public static void ny​(long struct,
                      int value)
        Unsafe version of y.

      • nz

        public static void nz​(long struct,
                      int value)
        Unsafe version of z.