Mike-Solar
244d5e860f
CI / Build & test (Windows) (push) Failing after 7s
All crates take the oak-* kebab-case naming (oak-audio, oak-codec, oak-common, oak-core, oak-ffmpeg-link, oak-node, oak-otio, oak-plugin, oak-render, oak-storage, oak-task, oak-timeline, oak-undo), with the lib identifiers rewritten (oakrender:: -> oak_render::, oakcore_rs:: -> oak_core::, ...) across all 226 referencing files. The GUI application moves from the workspace root into crates/oak-app/: src/, build.rs (paths fixed for the new location) and tests/ travel with it, the root Cargo.toml becomes workspace-only ([workspace] + workspace.package + profiles), and the app package inherits the workspace version. The screenshots example becomes a standalone crate examples/simple_player/ with its own Cargo.toml. Every crate now inherits the single workspace version (version.workspace = true), and the workflows' crate paths and the build docs follow the renames. Validated with a clean cargo check --workspace.
69 lines
1.9 KiB
C
69 lines
1.9 KiB
C
|
|
|
|
#ifndef _ofxMemory_h_
|
|
#define _ofxMemory_h_
|
|
|
|
// Copyright OpenFX and contributors to the OpenFX project.
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define kOfxMemorySuite "OfxMemorySuite"
|
|
|
|
/** @brief 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.
|
|
*/
|
|
typedef struct OfxMemorySuiteV1 {
|
|
/** @brief Allocate memory.
|
|
|
|
\arg \c handle - effect instance to assosciate with this memory allocation, or NULL.
|
|
\arg \c nBytes number of bytes to allocate
|
|
\arg \c allocatedData pointer to the return value. Allocated memory will be alligned for any use.
|
|
|
|
This function has the host allocate memory using its own memory resources
|
|
and returns that to the plugin.
|
|
|
|
@returns
|
|
- ::kOfxStatOK the memory was sucessfully allocated
|
|
- ::kOfxStatErrMemory the request could not be met and no memory was allocated
|
|
|
|
*/
|
|
OfxStatus (*memoryAlloc)(void *handle,
|
|
size_t nBytes,
|
|
void **allocatedData);
|
|
|
|
/** @brief Frees memory.
|
|
|
|
\arg \c allocatedData pointer to memory previously returned by OfxMemorySuiteV1::memoryAlloc
|
|
|
|
This function frees any memory that was previously allocated via OfxMemorySuiteV1::memoryAlloc.
|
|
|
|
@returns
|
|
- ::kOfxStatOK the memory was sucessfully freed
|
|
- ::kOfxStatErrBadHandle \e allocatedData was not a valid pointer returned by OfxMemorySuiteV1::memoryAlloc
|
|
|
|
*/
|
|
OfxStatus (*memoryFree)(void *allocatedData);
|
|
} OfxMemorySuiteV1;
|
|
|
|
|
|
/** @file ofxMemory.h
|
|
This file contains the API for general purpose memory allocation from a host.
|
|
*/
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|