Package org.lwjgl.sdl

Class SDL_Surface

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

 struct SDL_Surface {
     SDL_SurfaceFlags flags;
     SDL_PixelFormat format;
     int w;
     int h;
     int pitch;
     void * pixels;
     int refcount;
     void * reserved;
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • FLAGS

      public static final int FLAGS
      The struct member offsets.

    • FORMAT

      public static final int FORMAT
      The struct member offsets.

    • W

      public static final int W
      The struct member offsets.

    • H

      public static final int H
      The struct member offsets.

    • PITCH

      public static final int PITCH
      The struct member offsets.

    • PIXELS

      public static final int PIXELS
      The struct member offsets.

    • REFCOUNT

      public static final int REFCOUNT
      The struct member offsets.

    • RESERVED

      public static final int RESERVED
      The struct member offsets.

  • Constructor Details

    • SDL_Surface

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

    • flags

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

    • format

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

    • w

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

    • h

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

    • pitch

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

    • pixels

      public @Nullable ByteBuffer pixels()
      Returns:
      a ByteBuffer view of the data pointed to by the pixels field.

    • refcount

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

    • flags

      public SDL_Surface flags(int value)
      Sets the specified value to the flags field.

    • format

      public SDL_Surface format(int value)
      Sets the specified value to the format field.

    • w

      public SDL_Surface w(int value)
      Sets the specified value to the w field.

    • h

      public SDL_Surface h(int value)
      Sets the specified value to the h field.

    • pitch

      public SDL_Surface pitch(int value)
      Sets the specified value to the pitch field.

    • pixels

      public SDL_Surface pixels(@Nullable ByteBuffer value)
      Sets the address of the specified ByteBuffer to the pixels field.

    • refcount

      public SDL_Surface refcount(int value)
      Sets the specified value to the refcount field.

    • set

      public SDL_Surface set(int flags, int format, int w, int h, int pitch, @Nullable ByteBuffer pixels, int refcount)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

      public static SDL_Surface calloc(MemoryStack stack)
      Returns a new SDL_Surface 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_Surface.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new SDL_Surface.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

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

    • nflags

      public static int nflags(long struct)
      Unsafe version of flags().

    • nformat

      public static int nformat(long struct)
      Unsafe version of format().

    • nw

      public static int nw(long struct)
      Unsafe version of w().

    • nh

      public static int nh(long struct)
      Unsafe version of h().

    • npitch

      public static int npitch(long struct)
      Unsafe version of pitch().

    • npixels

      public static @Nullable ByteBuffer npixels(long struct)
      Unsafe version of pixels.

    • nrefcount

      public static int nrefcount(long struct)
      Unsafe version of refcount().

    • nreserved

      public static long nreserved(long struct)

    • nflags

      public static void nflags(long struct, int value)
      Unsafe version of flags.

    • nformat

      public static void nformat(long struct, int value)
      Unsafe version of format.

    • nw

      public static void nw(long struct, int value)
      Unsafe version of w.

    • nh

      public static void nh(long struct, int value)
      Unsafe version of h.

    • npitch

      public static void npitch(long struct, int value)
      Unsafe version of pitch.

    • npixels

      public static void npixels(long struct, @Nullable ByteBuffer value)
      Unsafe version of pixels.

    • nrefcount

      public static void nrefcount(long struct, int value)
      Unsafe version of refcount.

    • nreserved

      public static void nreserved(long struct, long value)