Python API

Ignis (module)

Ignis python interface

CPUArchitecture

• Missing Documentation

CameraOrientation

General camera orientation

Properties

• Dir: Direction the camera is facing

• Eye: Origin of the camera

• Up: Vector defining the up of the camera

GPUArchitecture

• Missing Documentation

Ray

Single ray traced into the scene

Properties

• Direction: Direction of the ray

• Origin: Origin of the ray

• Range: Range (tmin, tmax) of the ray

Runtime

Renderer runtime allowing control of simulation and access to results

Properties

• Camera: (self) -> str

• FrameCount: (self) -> int

• FramebufferHeight: (self) -> int

• FramebufferWidth: (self) -> int

• InitialCameraOrientation: (self) -> CameraOrientation

• IterationCount: (self) -> int

• SPI: (self) -> int

• SampleCount: (self) -> int

• Target: (self) -> Target

• Technique: (self) -> str

Methods

• clearFramebuffer(self) -> None

• clearFramebuffer(self, arg: str, /) -> None

• getFramebufferForDevice(self, aov: str = '') -> Image

• getFramebufferForHost(self, aov: str = '') -> CPUImage

• incFrameCount(self) -> None

• reset(self) -> None

• setCameraOrientationParameter(self, arg: CameraOrientation, /) -> None

• setParameter(self, arg0: str, arg1: int, /) -> None

• setParameter(self, arg0: str, arg1: float, /) -> None

• setParameter(self, arg0: str, arg1: Vec3, /) -> None

• setParameter(self, arg0: str, arg1: Vec4, /) -> None

• step(self, ignoreDenoiser: bool = False) -> None

• tonemap(self, arg: CPUArray2d_UInt32, /) -> None

• trace(self, arg: list[Ray], /) -> list[Vec3]

RuntimeOptions

Options to customize runtime behaviour

Properties

• AcquireStats: Set True if statistical data should be acquired while rendering

• DumpShader: Set True if most shader should be dumped into the filesystem

• DumpShaderFull: Set True if all shader should be dumped into the filesystem

• EnableTonemapping: Set True if any of the two tonemapping functions tonemap and imageinfo is to be used

• OverrideCamera: Type of camera to use instead of the one used by the scene

• OverrideFilmSize: Type of film size to use instead of the one used by the scene

• OverrideTechnique: Type of technique to use instead of the one used by the scene

• SPI: The requested sample per iteration. Can be 0 to set automatically

• Seed: Seed for the random generators

• Target: The target device

• WarnUnused: Set False if you want to ignore warnings about unused property entries

RuntimeWrap

Wrapper around the runtime used for proper runtime loading and shutdown

Properties

• instance: (self) -> Runtime

Methods

• shutdown(self) -> None

Scene

Class representing a whole scene

Properties

• bsdfs: (self) -> dict[str, SceneObject]

• camera: (self) -> SceneObject

• entities: (self) -> dict[str, SceneObject]

• film: (self) -> SceneObject

• lights: (self) -> dict[str, SceneObject]

• media: (self) -> dict[str, SceneObject]

• shapes: (self) -> dict[str, SceneObject]

• technique: (self) -> SceneObject

• textures: (self) -> dict[str, SceneObject]

Methods

• addBSDF(self, arg0: str, arg1: SceneObject, /) -> None

• addConstantEnvLight(self) -> None

• addEntity(self, arg0: str, arg1: SceneObject, /) -> None

• addFrom(self, arg: Scene, /) -> None

• addLight(self, arg0: str, arg1: SceneObject, /) -> None

• addMedium(self, arg0: str, arg1: SceneObject, /) -> None

• addShape(self, arg0: str, arg1: SceneObject, /) -> None

• addTexture(self, arg0: str, arg1: SceneObject, /) -> None

• bsdf(self, arg: str, /) -> SceneObject

• entity(self, arg: str, /) -> SceneObject

• light(self, arg: str, /) -> SceneObject

• medium(self, arg: str, /) -> SceneObject

• shape(self, arg: str, /) -> SceneObject

• texture(self, arg: str, /) -> SceneObject

SceneObject

Class representing an object in the scene

Properties

• baseDir: (self) -> os.PathLike

• pluginType: (self) -> str

• properties: (self) -> dict[str, SceneProperty]

• type: (self) -> SceneObject::Type

Methods

• hasProperty(self, arg: str, /) -> bool

• property(self, arg: str, /) -> SceneProperty

• setProperty(self, arg0: str, arg1: SceneProperty, /) -> None

SceneParser

Parser for standard JSON and glTF scene description

Methods

• loadFromFile(self, path: os.PathLike, flags: int = 13303) -> Scene

• loadFromString(self, str: str, opt_dir: os.PathLike = '', flags: int = 13303) -> Scene

SceneProperty

Property of an object in the scene

Properties

• type: (self) -> SceneProperty::Type

Methods

• canBeNumber(self) -> bool

• getBool(self, def: bool = False) -> bool

• getInteger(self, def: int = 0) -> int

• getIntegerArray(self) -> list[int]

• getNumber(self, def: float = 0.0) -> float

• getNumberArray(self) -> list[float]

• getString(self, def: str = '') -> str

• getTransform(self, def: Mat4x4 = [[1. 0. 0. 0.] [0. 1. 0. 0.] [0. 0. 1. 0.] [0. 0. 0. 1.]]) -> Mat4x4

• getVector2(self, def: Vec2 = [0. 0.]) -> Vec2

• getVector3(self, def: Vec3 = [0. 0. 0.]) -> Vec3

• isValid(self) -> bool

Target

Target specification the runtime is using

Properties

• CPUArchitecture: (self) -> CPUArchitecture

• Device: (self) -> int

• GPUArchitecture: (self) -> GPUArchitecture

• IsCPU: (self) -> bool

• IsGPU: (self) -> bool

• IsValid: (self) -> bool

• ThreadCount: (self) -> int

• VectorWidth: (self) -> int

Methods

• toString(self) -> str

SceneObject.Type

• Missing Documentation

SceneParser.Flags

• Missing Documentation

SceneProperty.Type

• Missing Documentation