Detailed Description

GuardDataRender is the safe access entry for abiDataRender.

Applications can use it to make C-based APIs safer. it would manage abiRefDataRender automatically. with that, App user do not need to refCopy_i or destroy abiRefDataRender manually.

For example: abiRefDataRender* rawRefRender = createRender(); GuardDataRender guardRender(rawRefRender, true); // take the ownership of rawRefRender guardRender.setUserData(userdata, [](void*){ ...free... }); guardRender.setErrorCallback([](ErrCode c, const char* msg){ stderr << msg; }); ErrCode c = guardRender.start(config, path); DS_ASSERT(isGood(c)); c = guardRender.start(config, path); // invoke abiDataRender::start_i(...) GuardDataMap data = ...; c = guardRender.preroll(data); // invoke abiDataRender::preroll_i(...) DS_ASSERT(isGood(c)); // invoke abiDataRender::render_i(...) c = guardRender.render(data, [](ErrCode c, const abiRefDataMap* d){ GuardDataMap doneData(*d); // check ErrCode and data. }); DS_ASSERT(isGood(c)); c = guardRender.flush(); // flush all data in queue c = guardRender.stop(); // invoke abiDataRender::stop_i(...) guardRender.reset(); // destroy abiRefDataRender, when all reference // destroyed, abiDataRender would be freed.

Definition at line 53 of file sources/includes/ds3d/common/hpp/datarender.hpp.

Inheritance diagram for ds3d::GuardDataRender:

[legend]

Collaboration diagram for ds3d::GuardDataRender:

[legend]

Public Types
using	abiRefType = abiRefT< abiDataRender >

using	abiRefType = abiRefT< abiDataRender >

Public Member Functions
template<typename... Args>
	GuardDataRender (Args &&... args)

	~GuardDataRender ()=default

ErrCode	preroll (GuardDataMap datamap)

ErrCode	render (GuardDataMap datamap, abiOnDataCB::CppFunc dataDoneCB)

GuardWindow	getWindow () const

template<typename... Args>
	GuardDataRender (Args &&... args)

	~GuardDataRender ()=default

ErrCode	preroll (GuardDataMap datamap)

ErrCode	render (GuardDataMap datamap, abiOnDataCB::CppFunc dataDoneCB)

GuardWindow	getWindow () const

void	setUserData (void *data, DelF delF)

void	setUserData (void *data, DelF delF)

virtual void *	getUserData () const

virtual void *	getUserData () const

void	setErrorCallback (abiErrorCB::CppFunc errCb)

void	setErrorCallback (abiErrorCB::CppFunc errCb)

ErrCode	start (const std::string &content, const std::string &path="")

ErrCode	start (const std::string &content, const std::string &path="")

ErrCode	flush ()

ErrCode	flush ()

ErrCode	stop ()

ErrCode	stop ()

State	state () const

State	state () const

std::string	getCaps (CapsPort port)

std::string	getCaps (CapsPort port)

std::string	getOutputCaps ()

std::string	getOutputCaps ()

std::string	getInputCaps ()

std::string	getInputCaps ()

GuardTy	cast ()

GuardTy	cast ()

abiDataRender *	ptr () const

abiDataRender *	ptr () const

abiDataRender *	operator-> () const

abiDataRender *	operator-> () const

	operator bool () const

	operator bool () const

	operator ShrdPtr< abiDataRender > ()

	operator ShrdPtr< abiDataRender > ()

abiRefT< abiDataRender > *	release ()

abiRefT< abiDataRender > *	release ()

void	reset (abiRefT< abiDataRender > *abiref=nullptr)

void	reset (abiRefT< abiDataRender > *abiref=nullptr)

abiRefT< abiDataRender > *	abiRef () const

abiRefT< abiDataRender > *	abiRef () const