Package org.lwjgl.assimp

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 are supported by the current Assimp-build and GetExportFormatDescription to retrieve the description of the export format option.

    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()
        Specified by:
        sizeof in class org.lwjgl.system.Struct

      • id, idString

        public java.nio.ByteBuffer id()

public java.lang.String idString()
        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, descriptionString

        public java.nio.ByteBuffer description()

public java.lang.String descriptionString()
        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, fileExtensionString

        public java.nio.ByteBuffer fileExtension()

public java.lang.String fileExtensionString()
        Recommended file extension for the exported file in lower case.

      • 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.

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • 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.

      • mallocStack

        @Deprecated
public static AIExportFormatDesc mallocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

      • callocStack

        @Deprecated
public static AIExportFormatDesc callocStack​(org.lwjgl.system.MemoryStack stack)
        Deprecated.
        Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

      • malloc

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

      • calloc

        public static AIExportFormatDesc calloc​(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

      • malloc

        public static AIExportFormatDesc.Buffer malloc​(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

      • calloc

        public static AIExportFormatDesc.Buffer calloc​(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

      • 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