Package org.lwjgl.vulkan

Class VkExtent3D

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkExtent3D>
org.lwjgl.vulkan.VkExtent3D
All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer
public class VkExtent3D extends Struct<VkExtent3D> implements NativeResource

 struct VkExtent3D {
     uint32_t width;
     uint32_t height;
     uint32_t depth;
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • WIDTH

      public static final int WIDTH
      The struct member offsets.

    • HEIGHT

      public static final int HEIGHT
      The struct member offsets.

    • DEPTH

      public static final int DEPTH
      The struct member offsets.

  • Constructor Details

    • VkExtent3D

      public VkExtent3D(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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<VkExtent3D>

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

      public static @Nullable 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(int capacity)
      Returns a new VkExtent3D.Buffer instance allocated with BufferUtils.
      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

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

    • mallocStack

      @Deprecated public static VkExtent3D mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkExtent3D callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkExtent3D mallocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkExtent3D callocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkExtent3D.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkExtent3D.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkExtent3D.Buffer mallocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkExtent3D.Buffer callocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

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

    • calloc

      public static VkExtent3D calloc(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

    • malloc

      public static VkExtent3D.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new VkExtent3D.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkExtent3D.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new VkExtent3D.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

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