Package org.lwjgl.sdl

Class SDL_GPUBufferRegion

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

 struct SDL_GPUBufferRegion {
     SDL_GPUBuffer * buffer;
     Uint32 offset;
     Uint32 size;
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • BUFFER

      public static final int BUFFER
      The struct member offsets.

    • OFFSET

      public static final int OFFSET
      The struct member offsets.

    • SIZE

      public static final int SIZE
      The struct member offsets.

  • Constructor Details

    • SDL_GPUBufferRegion

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

    • buffer

      public long buffer()
      Returns:
      the value of the buffer field.

    • offset

      public int offset()
      Returns:
      the value of the offset field.

    • size

      public int size()
      Returns:
      the value of the size field.

    • buffer

      public SDL_GPUBufferRegion buffer(long value)
      Sets the specified value to the buffer field.

    • offset

      public SDL_GPUBufferRegion offset(int value)
      Sets the specified value to the offset field.

    • size

      public SDL_GPUBufferRegion size(int value)
      Sets the specified value to the size field.

    • set

      public SDL_GPUBufferRegion set(long buffer, int offset, int size)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nbuffer

      public static long nbuffer(long struct)
      Unsafe version of buffer().

    • noffset

      public static int noffset(long struct)
      Unsafe version of offset().

    • nsize

      public static int nsize(long struct)
      Unsafe version of size().

    • nbuffer

      public static void nbuffer(long struct, long value)
      Unsafe version of buffer.

    • noffset

      public static void noffset(long struct, int value)
      Unsafe version of offset.

    • nsize

      public static void nsize(long struct, int value)
      Unsafe version of size.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate