Interface to scene materials. More...

#include <BRAY_Interface.h>

Public Member Functions
	MaterialPtr (BRAY_VexMaterial *mat=nullptr)

	~MaterialPtr ()

bool	isValid () const

void	updateSurface (const ScenePtr &scene, const UT_StringArray &arguments)
	Update the surface shader and arguments. More...

bool	updateDisplace (ScenePtr &scene, const UT_StringArray &arguments)

void	updateLens (const ScenePtr &scene, const UT_StringArray &arguments)
	Update the lens shader and arguments. More...

void	updateSurfaceCode (const ScenePtr &scene, const UT_StringHolder &name, const UT_StringRef &code, bool preload=false)

bool	updateDisplaceCode (const ScenePtr &scene, const UT_StringHolder &name, const UT_StringRef &code, bool preload=false)

void	updateLensCode (const ScenePtr &scene, const UT_StringHolder &name, const UT_StringRef &code, bool preload=false)

void	updateSurfaceGraph (const ScenePtr &scene, const UT_StringHolder &name, const ShaderGraphPtr &graphptr)
	Update the surface shader graph. More...

bool	updateDisplaceGraph (ScenePtr &scene, const UT_StringHolder &name, const ShaderGraphPtr &graphptr)

void	updateLensGraph (const ScenePtr &scene, const UT_StringHolder &name, const ShaderGraphPtr &graphptr)
	Update the lens shader graph. More...

void	setInputs (const ScenePtr &scene, const MaterialInputList &inputs, bool for_surface)
	Set the material input list. More...

void	setNiceName (const UT_StringHolder &nicename)
	Set stable name to use with built-in cryptomatte material name layer. More...

PrimvarSet	primvars () const


SYS_SAFE_BOOL	operator bool () const

const BRAY_VexMaterial *	materialPtr () const

Static Public Member Functions
static PrimvarSet	defaultPrimvars ()
	Return the primvars used by the default material. More...

Detailed Description

Interface to scene materials.

Definition at line 606 of file BRAY_Interface.h.

Constructor & Destructor Documentation

BRAY::MaterialPtr::MaterialPtr ( BRAY_VexMaterial * mat = nullptr )

inline

Definition at line 609 of file BRAY_Interface.h.

BRAY::MaterialPtr::~MaterialPtr ( )

inline

Definition at line 613 of file BRAY_Interface.h.

Member Function Documentation

static PrimvarSet BRAY::MaterialPtr::defaultPrimvars ( )

static

Return the primvars used by the default material.

bool BRAY::MaterialPtr::isValid ( ) const

inline

Definition at line 615 of file BRAY_Interface.h.

const BRAY_VexMaterial* BRAY::MaterialPtr::materialPtr ( ) const

inline

Access to the underling material

Definition at line 620 of file BRAY_Interface.h.

SYS_SAFE_BOOL BRAY::MaterialPtr::operator bool ( ) const

inline

Access to the underling material

Definition at line 619 of file BRAY_Interface.h.

PrimvarSet BRAY::MaterialPtr::primvars ( ) const

Return the primvars required by this material. If a nullptr is returned, it means that Karma wasn't able to determine primvars and all primvars might be required.

void BRAY::MaterialPtr::setInputs	(	const ScenePtr &	scene,
		const MaterialInputList &	inputs,
		bool	for_surface
	)

Set the material input list.

void BRAY::MaterialPtr::setNiceName ( const UT_StringHolder & nicename )

Set stable name to use with built-in cryptomatte material name layer.

bool BRAY::MaterialPtr::updateDisplace	(	ScenePtr &	scene,
		const UT_StringArray &	arguments
	)

Update the displacement shader and arguments Returns true if arguments changed.

bool BRAY::MaterialPtr::updateDisplaceCode	(	const ScenePtr &	scene,
		const UT_StringHolder &	name,
		const UT_StringRef &	code,
		bool	preload = `false`
	)

Update displacement shader VEX code The preload flag is used when other shaders in the network might depend on the code being updated. Returns true if the name or the code changed.

bool BRAY::MaterialPtr::updateDisplaceGraph	(	ScenePtr &	scene,
		const UT_StringHolder &	name,
		const ShaderGraphPtr &	graphptr
	)

Update the displacement shader graph Returns true if the name or the code changed.

void BRAY::MaterialPtr::updateLens	(	const ScenePtr &	scene,
		const UT_StringArray &	arguments
	)

Update the lens shader and arguments.

void BRAY::MaterialPtr::updateLensCode	(	const ScenePtr &	scene,
		const UT_StringHolder &	name,
		const UT_StringRef &	code,
		bool	preload = `false`
	)

Update surface shader VEX code. The preload flag is used when other shaders in the network might depend on the code being updated.

void BRAY::MaterialPtr::updateLensGraph	(	const ScenePtr &	scene,
		const UT_StringHolder &	name,
		const ShaderGraphPtr &	graphptr
	)

Update the lens shader graph.

void BRAY::MaterialPtr::updateSurface	(	const ScenePtr &	scene,
		const UT_StringArray &	arguments
	)

Update the surface shader and arguments.

void BRAY::MaterialPtr::updateSurfaceCode	(	const ScenePtr &	scene,
		const UT_StringHolder &	name,
		const UT_StringRef &	code,
		bool	preload = `false`
	)

Update surface shader VEX code. The preload flag is used when other shaders in the network might depend on the code being updated.

void BRAY::MaterialPtr::updateSurfaceGraph	(	const ScenePtr &	scene,
		const UT_StringHolder &	name,
		const ShaderGraphPtr &	graphptr
	)

Update the surface shader graph.

The documentation for this class was generated from the following file:

BRAY/BRAY_Interface.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation