Class AIExportFormatDesc

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

    public class AIExportFormatDesc
    extends Struct
    implements 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 {
         char const * id;
         char const * description;
         char const * fileExtension;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • ID, DESCRIPTION, FILEEXTENSION

        The struct member offsets.
    • 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class 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.
      • nid

        public static java.nio.ByteBuffer nid​(long struct)
        Unsafe version of id().
      • nidString

        public static java.lang.String nidString​(long struct)
        Unsafe version of idString().
      • ndescription

        public static java.nio.ByteBuffer ndescription​(long struct)
        Unsafe version of description().
      • ndescriptionString

        public static java.lang.String ndescriptionString​(long struct)
        Unsafe version of descriptionString().
      • nfileExtension

        public static java.nio.ByteBuffer nfileExtension​(long struct)
        Unsafe version of fileExtension().
      • nfileExtensionString

        public static java.lang.String nfileExtensionString​(long struct)
        Unsafe version of fileExtensionString().
      • nid

        public static void nid​(long struct,
                               java.nio.ByteBuffer value)
        Unsafe version of id.
      • ndescription

        public static void ndescription​(long struct,
                                        java.nio.ByteBuffer value)
        Unsafe version of description.
      • nfileExtension

        public static void nfileExtension​(long struct,
                                          java.nio.ByteBuffer value)
        Unsafe version of fileExtension.
      • 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 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