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, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkExtent3D extends org.lwjgl.system.Struct<VkExtent3D> implements org.lwjgl.system.NativeResource
Structure specifying a three-dimensional extent.
See Also

VkBufferImageCopy, VkBufferImageCopy2, VkCopyMemoryToImageIndirectCommandNV, VkImageCopy, VkImageCopy2, VkImageCreateInfo, VkImageFormatProperties, VkImageResolve, VkImageResolve2, VkImageToMemoryCopy, VkMemoryToImageCopy, VkQueueFamilyProperties, VkSparseImageFormatProperties, VkSparseImageMemoryBind, VkTilePropertiesQCOM

Layout


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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    VkExtent3D.Buffer
    An array of VkExtent3D structs.

    Nested classes/interfaces inherited from class org.lwjgl.system.Struct

    org.lwjgl.system.Struct.StructValidation

    Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

    org.lwjgl.system.Pointer.Default

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ALIGNOF
    The struct alignment in bytes.
    static final int
    DEPTH
    The struct member offsets.
    static final int
    HEIGHT
    The struct member offsets.
    static final int
    SIZEOF
    The struct size in bytes.
    static final int
    WIDTH
    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
    VkExtent3D(ByteBuffer container)
    Creates a VkExtent3D instance at the current position of the specified ByteBuffer container.

  • Method Summary

    Modifier and Type
    Method
    Description
    static VkExtent3D
    calloc()
    Returns a new VkExtent3D instance allocated with memCalloc.
    static VkExtent3D.Buffer
    calloc(int capacity)
    Returns a new VkExtent3D.Buffer instance allocated with memCalloc.
    static VkExtent3D.Buffer
    calloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new VkExtent3D.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    static VkExtent3D
    calloc(org.lwjgl.system.MemoryStack stack)
    Returns a new VkExtent3D instance allocated on the specified MemoryStack and initializes all its bits to zero.
    static VkExtent3D
    callocStack()
    Deprecated.
    static VkExtent3D.Buffer
    callocStack(int capacity)
    Deprecated.
    static VkExtent3D.Buffer
    callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static VkExtent3D
    callocStack(org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static VkExtent3D
    create()
    Returns a new VkExtent3D instance allocated with BufferUtils.
    static VkExtent3D.Buffer
    create(int capacity)
    Returns a new VkExtent3D.Buffer instance allocated with BufferUtils.
    static VkExtent3D
    create(long address)
    Returns a new VkExtent3D instance for the specified memory address.
    static VkExtent3D.Buffer
    create(long address, int capacity)
    Create a VkExtent3D.Buffer instance at the specified memory.
    static @Nullable VkExtent3D
    createSafe(long address)
    Like create, but returns null if address is NULL.
    static @Nullable VkExtent3D.Buffer
    createSafe(long address, int capacity)
    Like create, but returns null if address is NULL.
    int
    depth()
    the depth of the extent.
    VkExtent3D
    depth(int value)
    Sets the specified value to the depth() field.
    int
    height()
    the height of the extent.
    VkExtent3D
    height(int value)
    Sets the specified value to the height() field.
    static VkExtent3D
    malloc()
    Returns a new VkExtent3D instance allocated with memAlloc.
    static VkExtent3D.Buffer
    malloc(int capacity)
    Returns a new VkExtent3D.Buffer instance allocated with memAlloc.
    static VkExtent3D.Buffer
    malloc(int capacity, org.lwjgl.system.MemoryStack stack)
    Returns a new VkExtent3D.Buffer instance allocated on the specified MemoryStack.
    static VkExtent3D
    malloc(org.lwjgl.system.MemoryStack stack)
    Returns a new VkExtent3D instance allocated on the specified MemoryStack.
    static VkExtent3D
    mallocStack()
    Deprecated.
    static VkExtent3D.Buffer
    mallocStack(int capacity)
    Deprecated.
    static VkExtent3D.Buffer
    mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static VkExtent3D
    mallocStack(org.lwjgl.system.MemoryStack stack)
    Deprecated.
    static int
    ndepth(long struct)
    Unsafe version of depth().
    static void
    ndepth(long struct, int value)
    Unsafe version of depth.
    static int
    nheight(long struct)
    Unsafe version of height().
    static void
    nheight(long struct, int value)
    Unsafe version of height.
    static int
    nwidth(long struct)
    Unsafe version of width().
    static void
    nwidth(long struct, int value)
    Unsafe version of width.
    VkExtent3D
    set(int width, int height, int depth)
    Initializes this struct with the specified values.
    VkExtent3D
    set(VkExtent3D src)
    Copies the specified struct data to this struct.
    int
    sizeof()
     
    int
    width()
    the width of the extent.
    VkExtent3D
    width(int value)
    Sets the specified value to the width() field.

    Methods inherited from class org.lwjgl.system.Struct

    clear, free, isNull, validate, validate

    Methods inherited from class org.lwjgl.system.Pointer.Default

    address, equals, hashCode, toString

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.lwjgl.system.NativeResource

    close, free

  • 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()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<VkExtent3D>

    • width

      public int width()
      the width of the extent.

    • height

      public int height()
      the height of the extent.

    • depth

      public int depth()
      the depth of the extent.

    • 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(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkExtent3D callocStack(org.lwjgl.system.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, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

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

    • malloc

      public static VkExtent3D malloc(org.lwjgl.system.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(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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.