Class VkOffset3D

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

    public class VkOffset3D
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.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;
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  VkOffset3D.Buffer
      An array of VkOffset3D structs.
      • Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

        org.lwjgl.system.Pointer.Default
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALIGNOF
      The struct alignment in bytes.
      static int SIZEOF
      The struct size in bytes.
      static int X
      Y
      Z
      The struct member offsets.
      • Fields inherited from interface org.lwjgl.system.Pointer

        BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
    • Constructor Summary

      Constructors 
      Constructor Description
      VkOffset3D​(java.nio.ByteBuffer container)
      Creates a VkOffset3D instance at the current position of the specified ByteBuffer container.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static VkOffset3D calloc()
      Returns a new VkOffset3D instance allocated with memCalloc.
      static VkOffset3D.Buffer calloc​(int capacity)
      Returns a new VkOffset3D.Buffer instance allocated with memCalloc.
      static VkOffset3D callocStack()
      Returns a new VkOffset3D instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      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.
      static VkOffset3D.Buffer callocStack​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkOffset3D.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static VkOffset3D callocStack​(org.lwjgl.system.MemoryStack stack)
      Returns a new VkOffset3D instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static VkOffset3D create()
      Returns a new VkOffset3D instance allocated with BufferUtils.
      static VkOffset3D.Buffer create​(int capacity)
      Returns a new VkOffset3D.Buffer instance allocated with BufferUtils.
      static VkOffset3D create​(long address)
      Returns a new VkOffset3D instance for the specified memory address.
      static VkOffset3D.Buffer create​(long address, int capacity)
      Create a VkOffset3D.Buffer instance at the specified memory.
      static VkOffset3D createSafe​(long address)
      Like create, but returns null if address is NULL.
      static VkOffset3D.Buffer createSafe​(long address, int capacity)
      Like create, but returns null if address is NULL.
      static VkOffset3D malloc()
      Returns a new VkOffset3D instance allocated with memAlloc.
      static VkOffset3D.Buffer malloc​(int capacity)
      Returns a new VkOffset3D.Buffer instance allocated with memAlloc.
      static VkOffset3D mallocStack()
      Returns a new VkOffset3D instance allocated on the thread-local MemoryStack.
      static VkOffset3D.Buffer mallocStack​(int capacity)
      Returns a new VkOffset3D.Buffer instance allocated on the thread-local MemoryStack.
      static VkOffset3D.Buffer mallocStack​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkOffset3D.Buffer instance allocated on the specified MemoryStack.
      static VkOffset3D mallocStack​(org.lwjgl.system.MemoryStack stack)
      Returns a new VkOffset3D instance allocated on the specified MemoryStack.
      static int nx​(long struct)
      Unsafe version of x().
      static void nx​(long struct, int value)
      Unsafe version of x.
      static int ny​(long struct)
      Unsafe version of y().
      static void ny​(long struct, int value)
      Unsafe version of y.
      static int nz​(long struct)
      Unsafe version of z().
      static void nz​(long struct, int value)
      Unsafe version of z.
      VkOffset3D set​(int x, int y, int z)
      Initializes this struct with the specified values.
      VkOffset3D set​(VkOffset3D src)
      Copies the specified struct data to this struct.
      int sizeof()  
      int x()
      Returns the value of the x field.
      VkOffset3D x​(int value)
      Sets the specified value to the x field.
      int y()
      Returns the value of the y field.
      VkOffset3D y​(int value)
      Sets the specified value to the y field.
      int z()
      Returns the value of the z field.
      VkOffset3D z​(int value)
      Sets the specified value to the z field.
      • Methods inherited from interface org.lwjgl.system.NativeResource

        close, free
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from class org.lwjgl.system.Pointer.Default

        address, equals, hashCode, toString
      • Methods inherited from class org.lwjgl.system.Struct

        clear, free, isNull
    • 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()
        Specified by:
        sizeof in class org.lwjgl.system.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​(int capacity)
        Returns a new VkOffset3D.Buffer instance allocated with BufferUtils.
        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​(org.lwjgl.system.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​(org.lwjgl.system.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
      • mallocStack

        public static VkOffset3D.Buffer mallocStack​(int capacity)
        Returns a new VkOffset3D.Buffer instance allocated on the thread-local MemoryStack.
        Parameters:
        capacity - the buffer capacity
      • 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
      • mallocStack

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

        public static VkOffset3D.Buffer callocStack​(int capacity,
                                                    org.lwjgl.system.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.