HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SessionSync

Functions

HAPI_DECL HAPI_SetSessionSync (const HAPI_Session *session, HAPI_Bool enable)
 Enable or disable SessionSync mode. More...
 
HAPI_DECL HAPI_GetViewport (const HAPI_Session *session, HAPI_Viewport *viewport)
 Get the HAPI_Viewport info for synchronizing viewport in SessionSync. When SessionSync is running this will return Houdini's current viewport information. More...
 
HAPI_DECL HAPI_SetViewport (const HAPI_Session *session, const HAPI_Viewport *viewport)
 Set the HAPI_Viewport info for synchronizing viewport in SessionSync. When SessionSync is running, this can be used to set the viewport information which Houdini will then synchronizse with for its viewport. More...
 
HAPI_DECL HAPI_GetSessionSyncInfo (const HAPI_Session *session, HAPI_SessionSyncInfo *session_sync_info)
 Get the HAPI_SessionSyncInfo for synchronizing SessionSync state between Houdini and Houdini Engine integrations. More...
 
HAPI_DECL HAPI_SetSessionSyncInfo (const HAPI_Session *session, const HAPI_SessionSyncInfo *session_sync_info)
 Set the HAPI_SessionSyncInfo for synchronizing SessionSync state between Houdini and Houdini Engine integrations. More...
 

Detailed Description

Functions for working with SessionSync

Function Documentation

HAPI_DECL HAPI_GetSessionSyncInfo ( const HAPI_Session session,
HAPI_SessionSyncInfo session_sync_info 
)

Get the HAPI_SessionSyncInfo for synchronizing SessionSync state between Houdini and Houdini Engine integrations.

Parameters
[in]sessionThe session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[out]session_sync_infoThe output HAPI_SessionSyncInfo.
HAPI_DECL HAPI_GetViewport ( const HAPI_Session session,
HAPI_Viewport viewport 
)

Get the HAPI_Viewport info for synchronizing viewport in SessionSync. When SessionSync is running this will return Houdini's current viewport information.

Parameters
[in]sessionThe session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[out]viewportThe output HAPI_Viewport.
HAPI_DECL HAPI_SetSessionSync ( const HAPI_Session session,
HAPI_Bool  enable 
)

Enable or disable SessionSync mode.

Parameters
[in]sessionThe session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]enableEnable or disable SessionSync mode.
HAPI_DECL HAPI_SetSessionSyncInfo ( const HAPI_Session session,
const HAPI_SessionSyncInfo session_sync_info 
)

Set the HAPI_SessionSyncInfo for synchronizing SessionSync state between Houdini and Houdini Engine integrations.

Parameters
[in]sessionThe session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]session_sync_infoA HAPI_SessionSyncInfo that stores the state.
HAPI_DECL HAPI_SetViewport ( const HAPI_Session session,
const HAPI_Viewport viewport 
)

Set the HAPI_Viewport info for synchronizing viewport in SessionSync. When SessionSync is running, this can be used to set the viewport information which Houdini will then synchronizse with for its viewport.

Parameters
[in]sessionThe session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]viewportA HAPI_Viewport that stores the viewport.