Class AIExportFormatDesc

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer


    public class AIExportFormatDesc
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Describes an file format which Assimp can export to. Use GetExportFormatCount to learn how many export formats the current Assimp build supports and GetExportFormatDescription to retrieve a description of an export format option.

    Member documentation

    • id – a short string ID to uniquely identify the export format. Use this ID string to specify which file format you want to export to when calling ExportScene. Example: "dae" or "obj"
    • description – A short description of the file format to present to users. Useful if you want to allow the user to select an export format.
    • fileExtension – Recommended file extension for the exported file in lower case.

    Layout

     struct aiExportFormatDesc {
         const char * id;
         const char * description;
         const char * fileExtension;
     }
    • Field Detail

      • SIZEOF

        public static final int SIZEOF
        The struct size in bytes.
    • Constructor Detail

      • AIExportFormatDesc

        public AIExportFormatDesc(java.nio.ByteBuffer container)
        Creates a AIExportFormatDesc 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 Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • id

        public java.nio.ByteBuffer id()
        Returns a ByteBuffer view of the null-terminated string pointed to by the id field.
      • idString

        public java.lang.String idString()
        Decodes the null-terminated string pointed to by the id field.
      • description

        public java.nio.ByteBuffer description()
        Returns a ByteBuffer view of the null-terminated string pointed to by the description field.
      • descriptionString

        public java.lang.String descriptionString()
        Decodes the null-terminated string pointed to by the description field.
      • fileExtension

        public java.nio.ByteBuffer fileExtension()
        Returns a ByteBuffer view of the null-terminated string pointed to by the fileExtension field.
      • fileExtensionString

        public java.lang.String fileExtensionString()
        Decodes the null-terminated string pointed to by the fileExtension field.
      • id

        public AIExportFormatDesc id(java.nio.ByteBuffer value)
        Sets the address of the specified encoded string to the id field.
      • description

        public AIExportFormatDesc description(java.nio.ByteBuffer value)
        Sets the address of the specified encoded string to the description field.
      • fileExtension

        public AIExportFormatDesc fileExtension(java.nio.ByteBuffer value)
        Sets the address of the specified encoded string to the fileExtension field.
      • set

        public AIExportFormatDesc set(java.nio.ByteBuffer id,
                                      java.nio.ByteBuffer description,
                                      java.nio.ByteBuffer fileExtension)
        Initializes this struct with the specified values.
      • createSafe

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

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

        public static AIExportFormatDesc callocStack()
        Returns a new AIExportFormatDesc instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

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

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

        public static AIExportFormatDesc.Buffer callocStack(int capacity)
        Returns a new AIExportFormatDesc.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • mallocStack

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

        public static AIExportFormatDesc.Buffer callocStack(int capacity,
                                                            org.lwjgl.system.MemoryStack stack)
        Returns a new AIExportFormatDesc.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • validate

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

        public static void validate(long array,
                                    int count)
        Calls AIExportFormatDesc.validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array