BRAY::RendererPtr Class Reference

Interface to the renderer. More...

#include <BRAY_Interface.h>

Classes
struct	ImagePlane
	Class used to define image planes. More...

Public Member Functions
	RendererPtr ()=default
	~RendererPtr ()
SYS_SAFE_BOOL	operator bool () const
const BRAY::Stats &	stats () const
	Access the stats for this render. More...
bool	prepareRender ()
void	render (bool(*stopreq)(void *)=nullptr, void *data=nullptr)
	Start rendering a scene. More...
bool	isRendering () const
	Test to see whether the current renderer is active. More...
bool	isError () const
	Test to see if there was an error rendering. More...
bool	isPaused () const
	Test to see if the renderer is paused. More...
void	prepareForStop ()
	Tells the renderer to prepare to be stopped. More...
bool	pauseRender ()
	Pause rendering – Returns true if the renderer is paused. More...
bool	resumeRender ()
	Restart rendering – Returns true if isRendering();. More...
void	setPriority (int x, int y)
	Set a point in the image to give priority to rendering. More...
void	setPriority (const UT_DimRect &region)
	Set a region in the image which should have priority. More...
void	clearPriority ()
	Clear the priority focus. More...
bool	enableImageFilters (const UT_StringHolder &filters_opt, bool is_render_settings_prim)
void	setUseRenderSettingsPrim (bool use_render_settings_prim)
	Set whether to use render settings prim or display options. More...
void	clearOutputPlanes ()
AOVBufferPtr	addOutputPlane (const ImagePlane &plane)
int	getAOVCount () const

Static Public Member Functions
static RendererPtr	allocRenderer (BRAY::ScenePtr &sceneptr)
	Allocate renderer. More...

Detailed Description

Interface to the renderer.

Definition at line 1266 of file BRAY_Interface.h.

Constructor & Destructor Documentation

BRAY::RendererPtr::RendererPtr ( )

default

BRAY::RendererPtr::~RendererPtr ( )

inline

Definition at line 1280 of file BRAY_Interface.h.

Member Function Documentation

AOVBufferPtr BRAY::RendererPtr::addOutputPlane

(

const ImagePlane &

plane

)

Define image planes for rendering

static RendererPtr BRAY::RendererPtr::allocRenderer ( BRAY::ScenePtr &  sceneptr )

static

Allocate renderer.

void BRAY::RendererPtr::clearOutputPlanes

(

)

Define image planes for rendering

void BRAY::RendererPtr::clearPriority

(

)

Clear the priority focus.

bool BRAY::RendererPtr::enableImageFilters	(	const UT_StringHolder &	filters_opt,
		bool	is_render_settings_prim
	)

Enables image filters by the given option. The is_render_settings_prim indicates whether the filter belongs to render settings prim or the display options.

int BRAY::RendererPtr::getAOVCount

(

)

const

Define image planes for rendering

bool BRAY::RendererPtr::isError

(

)

const

Test to see if there was an error rendering.

bool BRAY::RendererPtr::isPaused

(

)

const

Test to see if the renderer is paused.

bool BRAY::RendererPtr::isRendering

(

)

const

Test to see whether the current renderer is active.

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

inline

Definition at line 1285 of file BRAY_Interface.h.

bool BRAY::RendererPtr::pauseRender

(

)

Pause rendering – Returns true if the renderer is paused.

void BRAY::RendererPtr::prepareForStop

(

)

Tells the renderer to prepare to be stopped.

bool BRAY::RendererPtr::prepareRender

(

)

Call before rendering begins. This lets the renderer prepare data structures before render() is called. For example, this will ensure all AOV buffers are allocated and active. The method returns false if there were errors setting up the render.

void BRAY::RendererPtr::render	(	bool(*)(void *)	stopreq = nullptr,
		void *	data = nullptr
	)

Start rendering a scene.

bool BRAY::RendererPtr::resumeRender

(

)

Restart rendering – Returns true if isRendering();.

void BRAY::RendererPtr::setPriority	(	int	x,
		int	y
	)

Set a point in the image to give priority to rendering.

void BRAY::RendererPtr::setPriority

(

const UT_DimRect &

region

)

Set a region in the image which should have priority.

void BRAY::RendererPtr::setUseRenderSettingsPrim

(

bool

use_render_settings_prim

)

Set whether to use render settings prim or display options.

const BRAY::Stats& BRAY::RendererPtr::stats

(

)

const

Access the stats for this render.

---

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

• BRAY/BRAY_Interface.h