PathEngine home previous: PathEngine_InitialiseAndObtainRootInterfacenext: PathEngine_SetDefaultAllocator
Contents, API Reference, Functions, PathEngine_InitialiseCP3DAndObtainInterface

PathEngine_InitialiseCP3DAndObtainInterface

Description

Initialises the 3D content processing, and obtains an interface pointer (static and Linux .so linkage).

Syntax

This function is defined in 'SDKRoot/interface/PathEngine_DirectLinkage.h', (included in the source code archives), as follows:
extern "C"
{
iContentProcessing3D*
PathEngine_InitialiseCP3DAndObtainInterface();
}

Return Value

A pointer to the Interface iContentProcessing3D interface, providing access the PathEngine 3D content processing functionality.

Requirements

The root interface must be initialised, with PathEngine_InitialiseAndObtainRootInterface (and not shutdown), before calling this function.

Remarks

This function is provided for SDK initialisation in the case of either direct linkage to PathEngine as a set of static libraries, or Linux shared object linkage.
Refer to Linking with the SDK for more information about different ways of linking with the SDK.

The lifetime of the iContentProcessing3D interface object returned by this function is managed through the SDK API object reference count mechanism. (Once you no longer require this object, you can call delete on the object pointer, and if there are no other outstanding references the object will be destroyed.)

This function must be called from the main thread.


Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: PathEngine_SetDefaultAllocator