Module hapi_rs::session

Expand description

Session is responsible for communicating with HAPI

The Engine promises to be thread-safe when accessing a single Session from multiple threads. hapi-rs relies on this promise and the Session struct holds only an Arc pointer to the session, and does not protect the session with Mutex, although there is a parking_lot::ReentrantMutex private member which is used internally in a few cases where API calls must be sequential.

When the last instance of the Session is about to get dropped, it’ll be cleaned up (if SessionOptions::cleanup was set) and automatically closed.

The Engine process (pipe or socket) can be auto-terminated as well if told so when starting the server: See start_engine_pipe_server and start_engine_socket_server

quick_session terminates the server by default. This is useful for quick one-off jobs.

Re-exports

pub use crate::asset::AssetLibrary;

pub use crate::node::HoudiniNode;

pub use crate::node::ManagerNode;

pub use crate::node::ManagerType;

pub use crate::node::NodeHandle;

pub use crate::parameter::Parameter;

pub use crate::stringhandle::StringArray;

Structs

CookOptions

Documentation

HapiError

Error type returned by all APIs

ImageFileFormat

NodeBuilder

Builder struct for Session::node_builder API

Session

Session represents a unique connection to the Engine instance and all API calls require a valid session. It implements Clone and is Send and Sync

SessionOptions

Session options passed to session create functions like connect_to_pipe

SessionOptionsBuilder

A build for SessionOptions.

SessionSyncInfo

TimelineOptions

Viewport

Enums

By which means the session communicates with the server.

CookResult

Result of async cook operation Session::cook

PackedPrimInstancingMode

Traits

EnvVariable

Trait bound for Session::get_server_var() and Session::set_server_var()

Functions

connect_to_pipe

Connect to the engine process via a pipe file. If timeout is Some, function will try to connect to the server multiple times every 100ms until timeout is reached.

connect_to_socket

Connect to the engine process via a Unix socket

new_in_process

Create in-process session

quick_session

A quick drop-in session, useful for on-off jobs It starts a single-threaded pipe server and initialize a session with default options

start_engine_pipe_server

Spawn a new pipe Engine process and return its PID

start_engine_socket_server

Spawn a new socket Engine server and return its PID

start_houdini_server

Start a interactive Houdini session with engine server embedded.

Type Definitions

Result

SessionState