Package org.lwjgl.vulkan

Class VkCopyMicromapInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkCopyMicromapInfoEXT>
org.lwjgl.vulkan.VkCopyMicromapInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkCopyMicromapInfoEXT extends org.lwjgl.system.Struct<VkCopyMicromapInfoEXT> implements org.lwjgl.system.NativeResource
Parameters for copying a micromap.
Valid Usage
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_COPY_MICROMAP_INFO_EXT
  • pNext must be NULL
  • src must be a valid VkMicromapEXT handle
  • dst must be a valid VkMicromapEXT handle
  • mode must be a valid VkCopyMicromapModeEXT value
  • Both of dst, and src must have been created, allocated, or retrieved from the same VkDevice
See Also

CmdCopyMicromapEXT, CopyMicromapEXT

Layout


 struct VkCopyMicromapInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkMicromapEXT src();
     VkMicromapEXT dst();
     VkCopyMicromapModeEXT mode();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • SRC

      public static final int SRC
      The struct member offsets.

    • DST

      public static final int DST
      The struct member offsets.

    • MODE

      public static final int MODE
      The struct member offsets.

  • Constructor Details

    • VkCopyMicromapInfoEXT

      public VkCopyMicromapInfoEXT(ByteBuffer container)
      Creates a VkCopyMicromapInfoEXT 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<VkCopyMicromapInfoEXT>

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • src

      public long src()
      the source micromap for the copy.

    • dst

      public long dst()
      the target micromap for the copy.

    • mode

      public int mode()
      a VkCopyMicromapModeEXT value specifying additional operations to perform during the copy.

    • sType

      public VkCopyMicromapInfoEXT sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkCopyMicromapInfoEXT sType$Default()
      Sets the STRUCTURE_TYPE_COPY_MICROMAP_INFO_EXT value to the sType() field.

    • pNext

      public VkCopyMicromapInfoEXT pNext(long value)
      Sets the specified value to the pNext() field.

    • src

      public VkCopyMicromapInfoEXT src(long value)
      Sets the specified value to the src() field.

    • dst

      public VkCopyMicromapInfoEXT dst(long value)
      Sets the specified value to the dst() field.

    • mode

      public VkCopyMicromapInfoEXT mode(int value)
      Sets the specified value to the mode() field.

    • set

      public VkCopyMicromapInfoEXT set(int sType, long pNext, long src, long dst, int mode)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

      public static VkCopyMicromapInfoEXT.Buffer create(int capacity)
      Returns a new VkCopyMicromapInfoEXT.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

      public static VkCopyMicromapInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkCopyMicromapInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

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

    • calloc

      public static VkCopyMicromapInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkCopyMicromapInfoEXT.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

    • nsType

      public static int nsType(long struct)
      Unsafe version of sType().

    • npNext

      public static long npNext(long struct)
      Unsafe version of pNext().

    • nsrc

      public static long nsrc(long struct)
      Unsafe version of src().

    • ndst

      public static long ndst(long struct)
      Unsafe version of dst().

    • nmode

      public static int nmode(long struct)
      Unsafe version of mode().

    • nsType

      public static void nsType(long struct, int value)
      Unsafe version of sType.

    • npNext

      public static void npNext(long struct, long value)
      Unsafe version of pNext.

    • nsrc

      public static void nsrc(long struct, long value)
      Unsafe version of src.

    • ndst

      public static void ndst(long struct, long value)
      Unsafe version of dst.

    • nmode

      public static void nmode(long struct, int value)
      Unsafe version of mode.