Package org.lwjgl.fmod

Class FMOD_STUDIO_SOUND_INFO

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

Layout


 struct FMOD_STUDIO_SOUND_INFO {
     char const * name_or_data;
     FMOD_MODE mode;
     FMOD_CREATESOUNDEXINFO exinfo;
     int subsoundindex;
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • NAME_OR_DATA

      public static final int NAME_OR_DATA
      The struct member offsets.

    • MODE

      public static final int MODE
      The struct member offsets.

    • EXINFO

      public static final int EXINFO
      The struct member offsets.

    • SUBSOUNDINDEX

      public static final int SUBSOUNDINDEX
      The struct member offsets.

  • Constructor Details

    • FMOD_STUDIO_SOUND_INFO

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

    • name_or_data

      public ByteBuffer name_or_data(int capacity)
      Parameters:
      capacity - the number of elements in the returned buffer
      Returns:
      a ByteBuffer view of the data pointed to by the name_or_data field.

    • mode

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

    • exinfo

      public FMOD_CREATESOUNDEXINFO exinfo()
      Returns:
      a FMOD_CREATESOUNDEXINFO view of the exinfo field.

    • subsoundindex

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

    • name_or_data

      public FMOD_STUDIO_SOUND_INFO name_or_data(ByteBuffer value)
      Sets the address of the specified ByteBuffer to the name_or_data field.

    • mode

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

    • exinfo

      public FMOD_STUDIO_SOUND_INFO exinfo(FMOD_CREATESOUNDEXINFO value)
      Copies the specified FMOD_CREATESOUNDEXINFO to the exinfo field.

    • exinfo

      public FMOD_STUDIO_SOUND_INFO exinfo(Consumer<FMOD_CREATESOUNDEXINFO> consumer)
      Passes the exinfo field to the specified Consumer.

    • subsoundindex

      public FMOD_STUDIO_SOUND_INFO subsoundindex(int value)
      Sets the specified value to the subsoundindex field.

    • set

      public FMOD_STUDIO_SOUND_INFO set(ByteBuffer name_or_data, int mode, FMOD_CREATESOUNDEXINFO exinfo, int subsoundindex)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nname_or_data

      public static ByteBuffer nname_or_data(long struct, int capacity)
      Unsafe version of name_or_data.

    • nmode

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

    • nexinfo

      public static FMOD_CREATESOUNDEXINFO nexinfo(long struct)
      Unsafe version of exinfo().

    • nsubsoundindex

      public static int nsubsoundindex(long struct)
      Unsafe version of subsoundindex().

    • nname_or_data

      public static void nname_or_data(long struct, ByteBuffer value)
      Unsafe version of name_or_data.

    • nmode

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

    • nexinfo

      public static void nexinfo(long struct, FMOD_CREATESOUNDEXINFO value)
      Unsafe version of exinfo.

    • nsubsoundindex

      public static void nsubsoundindex(long struct, int value)
      Unsafe version of subsoundindex.

    • validate

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