Assimp v5.2.2 (January 2022)
The Asset-Importer-Lib API documentation.
types.h File Reference

Basic data types and primitives, such as vectors or colors. More...

Classes

struct  aiColor3D
 Represents a color in Red-Green-Blue space. More...
 
struct  aiMemoryInfo
 Stores the memory requirements for different components (e.g. More...
 
struct  aiPlane
 Represents a plane in a three-dimensional, euclidean space. More...
 
struct  aiRay
 Represents a ray. More...
 
struct  aiString
 Represents an UTF-8 string, zero byte terminated. More...
 

Namespaces

namespace  Assimp
 Some C++ utilities for inter- and extrapolation.
 

Macros

#define AI_TYPES_H_INC
 

Typedefs

typedef int32_t ai_int32
 
typedef uint32_t ai_uint32
 

Enumerations

enum  aiDefaultLogStream { aiDefaultLogStream_FILE = 0x1 , aiDefaultLogStream_STDOUT = 0x2 , aiDefaultLogStream_STDERR = 0x4 , aiDefaultLogStream_DEBUGGER = 0x8 }
 Enumerates predefined log streaming destinations. More...
 
enum  aiOrigin { aiOrigin_SET = 0x0 , aiOrigin_CUR = 0x1 , aiOrigin_END = 0x2 }
 Seek origins (for the virtual file system API). More...
 
enum  aiReturn { aiReturn_SUCCESS = 0x0 , aiReturn_FAILURE = -0x1 , aiReturn_OUTOFMEMORY = -0x3 }
 Standard return type for some library functions. More...
 

Variables

static const size_t MAXLEN = 1024
 Maximum dimension for strings, ASSIMP strings are zero terminated. More...
 

Detailed Description

Basic data types and primitives, such as vectors or colors.

Macro Definition Documentation

◆ AI_TYPES_H_INC

#define AI_TYPES_H_INC

Typedef Documentation

◆ ai_int32

typedef int32_t ai_int32

◆ ai_uint32

typedef uint32_t ai_uint32

Enumeration Type Documentation

◆ aiDefaultLogStream

Enumerates predefined log streaming destinations.

Logging to these streams can be enabled with a single call to #LogStream::createDefaultStream.

Enumerator
aiDefaultLogStream_FILE 

Stream the log to a file.

aiDefaultLogStream_STDOUT 

Stream the log to std::cout.

aiDefaultLogStream_STDERR 

Stream the log to std::cerr.

aiDefaultLogStream_DEBUGGER 

MSVC only: Stream the log the the debugger (this relies on OutputDebugString from the Win32 SDK)

◆ aiOrigin

enum aiOrigin

Seek origins (for the virtual file system API).

Much cooler than using SEEK_SET, SEEK_CUR or SEEK_END.

Enumerator
aiOrigin_SET 

Beginning of the file.

aiOrigin_CUR 

Current position of the file pointer.

aiOrigin_END 

End of the file, offsets must be negative.

◆ aiReturn

enum aiReturn

Standard return type for some library functions.

Rarely used, and if, mostly in the C API.

Enumerator
aiReturn_SUCCESS 

Indicates that a function was successful.

aiReturn_FAILURE 

Indicates that a function failed.

aiReturn_OUTOFMEMORY 

Indicates that not enough memory was available to perform the requested operation.

Variable Documentation

◆ MAXLEN

const size_t MAXLEN = 1024
static

Maximum dimension for strings, ASSIMP strings are zero terminated.