OfxMemorySuiteV1 Struct Reference

#include <ofxMemory.h>

List of all members.


Detailed Description

The OFX suite that implements general purpose memory management.

Use this suite for ordinary memory management functions, where you would normally use malloc/free or new/delete on ordinary objects.

For images, you should use the memory allocation functions in the image effect suite, as many hosts have specific image memory pools.

Note:
C++ plugin developers will need to redefine new and delete as skins ontop of this suite.

Public Attributes

OfxStatus(* memoryAlloc )(void *handle, size_t nBytes, void **allocatedData)
 Allocate memory.
OfxStatus(* memoryFree )(void *allocatedData)
 Frees memory.

Member Data Documentation

OfxStatus(* OfxMemorySuiteV1::memoryAlloc)(void *handle, size_t nBytes, void **allocatedData)

Allocate memory.

  • handle - effect instance to assosciate with this memory allocation, or NULL.
  • nBytes - the number of bytes to allocate
  • allocatedData - a pointer to the return value. Allocated memory will be alligned for any use.
This function has the host allocate memory using it's own memory resources and returns that to the plugin.

Returns:

OfxStatus(* OfxMemorySuiteV1::memoryFree)(void *allocatedData)

Frees memory.

This function frees any memory that was previously allocated via OfxMemorySuiteV1::memoryAlloc.

Returns:


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

Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:
  1. Redistributions of the document must retain the above copyright notice and this list of conditions.
  2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Automatic documentation generated by DOxygen.