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.

Normally this function should be called just once, but the 3D content processing can be shut down explicitly, if desired, by calling PathEngine_ShutDownCP3D.
After explicit shutdown, it is then possible to call PathEngine_InitialiseCP3DAndObtainInterface() again, to reinitialise the interface.

The 3D content processing must be shut down before any call to PathEngine_ShutDown.

This function must be called from the main thread.


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