luxcore Namespace Reference

The LuxCore classes are defined within this namespace. More...

Classes
class	Film
	Film stores all the outputs of a rendering. It can be obtained from a RenderSession or as stand alone object loaded from a file. More...
class	Camera
	Camera stores camera definitions. More...
class	Scene
	Scene stores textures, materials and objects definitions. More...
class	RenderConfig
	RenderConfig stores all the configuration settings used to render a scene. More...
class	RenderState
	RenderState is used to resume a rendering from a previous saved point. More...
class	RenderSession
	RenderSession executes a rendering based on the RenderConfig provided. More...

Functions
CPP_EXPORT CPP_API void	Init (void(*LogHandler)(const char *)=NULL)
	Initializes LuxCore API. This function has to be called before anything else. This function is thread safe. More...
CPP_EXPORT CPP_API void	SetLogHandler (void(*LogHandler)(const char *)=NULL)
	Initializes LuxCore API. This function can be called if you want to update the log handler. More...
CPP_EXPORT CPP_API void	ParseLXS (const std::string &fileName, luxrays::Properties &renderConfig, luxrays::Properties &scene)
	Parses a scene described using LuxRender SDL (Scene Description Language). More...
CPP_EXPORT CPP_API void	KernelCacheFill (const luxrays::Properties &config, void(*ProgressHandler)(const size_t, const size_t)=NULL)
	File the OpenCL kernel cache with entries. More...
CPP_EXPORT CPP_API luxrays::Properties	GetPlatformDesc ()
	Return a list of properties describing the features available. The properties currently supported are: More...
CPP_EXPORT CPP_API luxrays::Properties	GetOpenCLDeviceDescs ()
	Return the list of OpenCL devices available. For instance: More...

Variables
CPP_EXPORT CPP_API void(*	LuxCore_LogHandler )(const char *msg)

Detailed Description

The LuxCore classes are defined within this namespace.

Function Documentation

CPP_EXPORT CPP_API luxrays::Properties luxcore::GetOpenCLDeviceDescs

(

)

Return the list of OpenCL devices available. For instance:

• opencl.device.0.name = "GeForce GTX 980"
• opencl.device.0.type = "OPENCL_GPU"
• opencl.device.0.units = 16
• opencl.device.0.nativevectorwidthfloat = 1
• opencl.device.0.maxmemory = 4294770688
• opencl.device.0.maxmemoryallocsize = 1073692672
• opencl.device.1.name = "Hawaii"
• opencl.device.1.type = "OPENCL_GPU"
• opencl.device.1.units = 44
• opencl.device.1.nativevectorwidthfloat = 1
• opencl.device.1.maxmemory = 3888119808
• opencl.device.1.maxmemoryallocsize = 2847670272
• opencl.device.2.name = "Intel(R) Core(TM) i7-3930K CPU @ 3.20GHz"
• opencl.device.2.type = "OPENCL_CPU"
• opencl.device.2.units = 12
• opencl.device.2.nativevectorwidthfloat = 8
• opencl.device.2.maxmemory = 16765145088
• opencl.device.2.maxmemoryallocsize = 4191286272

CPP_EXPORT CPP_API luxrays::Properties luxcore::GetPlatformDesc

(

)

Return a list of properties describing the features available. The properties currently supported are:

• version.number
  The LuxCore version. As string with "major.minor" version format.
• compile.LUXRAYS_DISABLE_OPENCL
  true or false if the sources has been compiled with LUXRAYS_DISABLE_OPENCL and OpenCL rendering engines are available or not.
• compile.LUXCORE_DISABLE_EMBREE_BVH_BUILDER
  true or false if the sources has been compiled with LUXCORE_DISABLE_EMBREE_BVH_BUILDER and Embree BVH builder is used for OpenCL or not. This is now always false.

CPP_EXPORT CPP_API void luxcore::Init

(

void(*)(const char *)

LogHandler = NULL

)

Initializes LuxCore API. This function has to be called before anything else. This function is thread safe.

Parameters

LogHandler

is a pointer to a function receiving all LuxCore log messages. If it is NULL, the default handler will be used.

CPP_EXPORT CPP_API void luxcore::KernelCacheFill	(	const luxrays::Properties &	config,
		void(*)(const size_t, const size_t)	ProgressHandler = NULL
	)

File the OpenCL kernel cache with entries.

Parameters

config

defines how to fill the cache. The supported properties are: kernelcachefill.renderengine.types, kernelcachefill.sampler.types, kernelcachefill.camera.types, kernelcachefill.geometry.types, kernelcachefill.light.types, kernelcachefill.material.types, kernelcachefill.texture.types. They can be used to define the list of types to use, for instance with a Property("kernelcachefill.renderengine.types")("PATHOCL", "TILEPATHOCL", "RTPATHOCL").

CPP_EXPORT CPP_API void luxcore::ParseLXS	(	const std::string &	fileName,
		luxrays::Properties &	renderConfig,
		luxrays::Properties &	scene
	)

Parses a scene described using LuxRender SDL (Scene Description Language).

Parameters

fileName	is the name of the file to parse.
renderConfig	is where the rendering configuration properties are returned.
scene	is where the scene properties are returned.

CPP_EXPORT CPP_API void luxcore::SetLogHandler

(

void(*)(const char *)

LogHandler = NULL

)

Initializes LuxCore API. This function can be called if you want to update the log handler.

Parameters

LogHandler

is a pointer to a function receiving all LuxCore log messages. If it is NULL, there will no printed information.

Variable Documentation

CPP_EXPORT CPP_API void(* luxcore::LuxCore_LogHandler)(const char *msg)

Definition at line 63 of file luxcore.h.