Public Member Functions | Public Attributes

KFbxMemoryAllocator Class Reference

This reference page is linked to from the following overview topics: Managing Memory with the FBX SDK Manager.


Search for all occurrences

Detailed Description

This class provides services for memory management.

The FBX SDK Manager uses an object of type KFbxMemoryAllocator to allocate and free memory, which is registered to KFbxSdkManager. The calls of memory management routines (FbxSdkMalloc, FbxSdkFree, FbxSdkNew, FbxSdkDelete, FbxSdkNewArray and FbxSdkDeleteArray) will be redirected to corresponding registered functions. Implement your own allocator if your application requires custom memory management.

See also:
KFbxSdkManager::SetMemoryAllocator(KFbxMemoryAllocator*)
Examples:

ExportScene05/main.cxx, and ViewScene/main.cxx.

Definition at line 55 of file kfbxmemoryallocator.h.

#include <kfbxmemoryallocator.h>

Inheritance diagram for KFbxMemoryAllocator:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  KFbxMemoryAllocator (void *(*pMallocHandler)(size_t), void *(*pCallocHandler)(size_t, size_t), void *(*pReallocHandler)(void *, size_t), void(*pFreeHandler)(void *), size_t(*pMsizeHandler)(void *))
  Constructor.
  KFbxMemoryAllocator (void *(*pMallocHandler)(size_t), void *(*pCallocHandler)(size_t, size_t), void *(*pReallocHandler)(void *, size_t), void(*pFreeHandler)(void *), size_t(*pMsizeHandler)(void *), void *(*pMallocHandler_debug)(size_t, int, const char *, int), void *(*pCallocHandler_debug)(size_t, size_t, int, const char *, int), void *(*pReallocHandler_debug)(void *, size_t, int, const char *, int), void(*pFreeHandler_debug)(void *, int), size_t(*pMsizeHandler_debug)(void *, int))
  Constructor.
virtual  ~KFbxMemoryAllocator ()=0

Public Attributes

void *(*  mMallocHandler )(size_t)
void *(*  mCallocHandler )(size_t, size_t)
void *(*  mReallocHandler )(void *, size_t)
void(*  mFreeHandler )(void *)
size_t(*  mMsizeHandler )(void *)
void *(*  mMallocHandler_debug )(size_t, int, const char *, int)
void *(*  mCallocHandler_debug )(size_t, size_t, int, const char *, int)
void *(*  mReallocHandler_debug )(void *, size_t, int, const char *, int)
void(*  mFreeHandler_debug )(void *, int)
size_t(*  mMsizeHandler_debug )(void *, int)

Constructor & Destructor Documentation

KFbxMemoryAllocator ( void *(*)(size_t)  pMallocHandler,
void *(*)(size_t, size_t)  pCallocHandler,
void *(*)(void *, size_t)  pReallocHandler,
void(*)(void *)  pFreeHandler,
size_t(*)(void *)  pMsizeHandler 
) [inline]

Constructor.

Parameters:
pMallocHandler Pointer to a function implementing malloc. This function allocates memory blocks.
pCallocHandler Pointer to a function implementing calloc. This function allocates an array in memory with elements initialized to 0.
pReallocHandler Pointer to a function implementing realloc. This function reallocate memory blocks.
pFreeHandler Pointer to a function implementing free. This function deallocates memory blocks.
pMsizeHandler Pointer to a function implementing msize. This function returns the size of a memory block allocated in the heap. See the macro _msize for its default implementation on different platforms.

Definition at line 65 of file kfbxmemoryallocator.h.

        : mMallocHandler(pMallocHandler)
        , mCallocHandler(pCallocHandler)
        , mReallocHandler(pReallocHandler)
        , mFreeHandler(pFreeHandler)
        , mMsizeHandler(pMsizeHandler)
        , mMallocHandler_debug(0)
        , mCallocHandler_debug(0)
        , mReallocHandler_debug(0)
        , mFreeHandler_debug(0)
        , mMsizeHandler_debug(0)
    {
    }
KFbxMemoryAllocator ( void *(*)(size_t)  pMallocHandler,
void *(*)(size_t, size_t)  pCallocHandler,
void *(*)(void *, size_t)  pReallocHandler,
void(*)(void *)  pFreeHandler,
size_t(*)(void *)  pMsizeHandler,
void *(*)(size_t, int, const char *, int)  pMallocHandler_debug,
void *(*)(size_t, size_t, int, const char *, int)  pCallocHandler_debug,
void *(*)(void *, size_t, int, const char *, int)  pReallocHandler_debug,
void(*)(void *, int)  pFreeHandler_debug,
size_t(*)(void *, int)  pMsizeHandler_debug 
) [inline]

Constructor.

Parameters:
pMallocHandler Pointer to a function implementing malloc. This function allocates memory blocks.
pCallocHandler Pointer to a function implementing calloc. This function allocates an array in memory with elements initialized to 0.
pReallocHandler Pointer to a function implementing realloc. This function reallocate memory blocks.
pFreeHandler Pointer to a function implementing free. This function deallocates memory blocks.
pMsizeHandler Pointer to a function implementing msize. This function returns the size of a memory block allocated in the heap. See the macro _msize for its default implementation on different platforms.
pMallocHandler_debug Pointer to a function implementing malloc_debug. This function allocates memory blocks, and store information for debugging purposes
pCallocHandler_debug Pointer to a function implementing calloc_debug. This function allocates an array in memory with elements initialized to 0, and store information for debugging purposes.
pReallocHandler_debug Pointer to a function implementing realloc_debug. This function reallocate memory blocks, and store information for debugging purposes.
pFreeHandler_debug Pointer to a function implementing free_debug. This function deallocates memory blocks, and store information for debugging purposes.
pMsizeHandler_debug Pointer to a function implementing msize_debug. This function returns the size of a memory block allocated in the heap, and store information for debugging purposes.

Definition at line 95 of file kfbxmemoryallocator.h.

        : mMallocHandler(pMallocHandler)
        , mCallocHandler(pCallocHandler)
        , mReallocHandler(pReallocHandler)
        , mFreeHandler(pFreeHandler)
        , mMsizeHandler(pMsizeHandler)
        , mMallocHandler_debug(pMallocHandler_debug)
        , mCallocHandler_debug(pCallocHandler_debug)
        , mReallocHandler_debug(pReallocHandler_debug)
        , mFreeHandler_debug(pFreeHandler_debug)
        , mMsizeHandler_debug(pMsizeHandler_debug)
    {
    }
virtual ~KFbxMemoryAllocator ( ) [pure virtual]

Member Data Documentation

void*(* mMallocHandler)(size_t)
void*(* mCallocHandler)(size_t, size_t)
void*(* mReallocHandler)(void *, size_t)
void(* mFreeHandler)(void *)
size_t(* mMsizeHandler)(void *)
void*(* mMallocHandler_debug)(size_t, int, const char *, int)
void*(* mCallocHandler_debug)(size_t, size_t, int, const char *, int)
void*(* mReallocHandler_debug)(void *, size_t, int, const char *, int)
void(* mFreeHandler_debug)(void *, int)
size_t(* mMsizeHandler_debug)(void *, int)

The documentation for this class was generated from the following file:

KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator
KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator KFbxMemoryAllocator