MRRenderModelParameters.h File Reference

#include <MRCMisc/exports.h>
#include <stdbool.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_TransparencyMode	MR_TransparencyMode
typedef enum MR_RenderModelPassMask	MR_RenderModelPassMask
	Various passes of the 3D rendering.

Enumerations
enum	MR_RenderModelPassMask {   MR_RenderModelPassMask_Opaque = 1 , MR_RenderModelPassMask_Transparent = 2 , MR_RenderModelPassMask_VolumeRendering = 4 , MR_RenderModelPassMask_NoDepthTest = 8 ,   MR_RenderModelPassMask_All = 15 }
	Various passes of the 3D rendering. More...

Functions
MRC_API MR_TransparencyMode *	MR_TransparencyMode_DefaultConstruct (void)
MRC_API MR_TransparencyMode *	MR_TransparencyMode_DefaultConstructArray (size_t num_elems)
MRC_API const MR_TransparencyMode *	MR_TransparencyMode_OffsetPtr (const MR_TransparencyMode *ptr, ptrdiff_t i)
MRC_API MR_TransparencyMode *	MR_TransparencyMode_OffsetMutablePtr (MR_TransparencyMode *ptr, ptrdiff_t i)
MRC_API MR_TransparencyMode *	MR_TransparencyMode_ConstructFromAnother (const MR_TransparencyMode *_other)
MRC_API MR_TransparencyMode *	MR_TransparencyMode_Construct_1 (bool alphaSort)
MRC_API MR_TransparencyMode *	MR_TransparencyMode_Construct_3 (unsigned int bgDepthTexId, unsigned int fgColorTexId, unsigned int fgDepthTexId)
MRC_API void	MR_TransparencyMode_Destroy (const MR_TransparencyMode *_this)
	Destroys a heap-allocated instance of MR_TransparencyMode. Does nothing if the pointer is null.
MRC_API void	MR_TransparencyMode_DestroyArray (const MR_TransparencyMode *_this)
	Destroys a heap-allocated array of MR_TransparencyMode. Does nothing if the pointer is null.
MRC_API MR_TransparencyMode *	MR_TransparencyMode_AssignFromAnother (MR_TransparencyMode *_this, const MR_TransparencyMode *_other)
MRC_API bool	MR_TransparencyMode_isAlphaSortEnabled (const MR_TransparencyMode *_this)
MRC_API bool	MR_TransparencyMode_isDepthPeelingEnabled (const MR_TransparencyMode *_this)
MRC_API unsigned int	MR_TransparencyMode_getBGDepthPeelingDepthTextureId (const MR_TransparencyMode *_this)
MRC_API unsigned int	MR_TransparencyMode_getFGDepthPeelingColorTextureId (const MR_TransparencyMode *_this)
MRC_API unsigned int	MR_TransparencyMode_getFGDepthPeelingDepthTextureId (const MR_TransparencyMode *_this)
MRC_API MR_RenderModelPassMask	MR_bitand_MR_RenderModelPassMask (MR_RenderModelPassMask a, MR_RenderModelPassMask b)
	Generated from function MR::operator&.
MRC_API MR_RenderModelPassMask	MR_bitor_MR_RenderModelPassMask (MR_RenderModelPassMask a, MR_RenderModelPassMask b)
	Generated from function MR::operator|.
MRC_API MR_RenderModelPassMask	MR_compl_MR_RenderModelPassMask (MR_RenderModelPassMask a)
	Generated from function MR::operator~.
MRC_API MR_RenderModelPassMask *	MR_bitand_assign_MR_RenderModelPassMask (MR_RenderModelPassMask *a, MR_RenderModelPassMask b)
MRC_API MR_RenderModelPassMask *	MR_bitor_assign_MR_RenderModelPassMask (MR_RenderModelPassMask *a, MR_RenderModelPassMask b)
MRC_API MR_RenderModelPassMask	MR_mul_MR_RenderModelPassMask_bool (MR_RenderModelPassMask a, bool b)
	Generated from function MR::operator*.
MRC_API MR_RenderModelPassMask	MR_mul_bool_MR_RenderModelPassMask (bool a, MR_RenderModelPassMask b)
	Generated from function MR::operator*.
MRC_API MR_RenderModelPassMask *	MR_mul_assign_MR_RenderModelPassMask_bool (MR_RenderModelPassMask *a, bool b)

Typedef Documentation

MR_RenderModelPassMask

typedef enum MR_RenderModelPassMask MR_RenderModelPassMask

Various passes of the 3D rendering.

MR_TransparencyMode

typedef struct MR_TransparencyMode MR_TransparencyMode

struct to determine transparent rendering mode Generated from class MR::TransparencyMode. Supported MR_PassBy modes: MR_PassBy_DefaultConstruct, MR_PassBy_Copy, MR_PassBy_Move (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

Enumeration Type Documentation

MR_RenderModelPassMask

enum MR_RenderModelPassMask

Various passes of the 3D rendering.

Enumerator
MR_RenderModelPassMask_Opaque
MR_RenderModelPassMask_Transparent
MR_RenderModelPassMask_VolumeRendering
MR_RenderModelPassMask_NoDepthTest
MR_RenderModelPassMask_All

Function Documentation

MR_bitand_assign_MR_RenderModelPassMask()

MRC_API MR_RenderModelPassMask * MR_bitand_assign_MR_RenderModelPassMask	(	MR_RenderModelPassMask *	a,
		MR_RenderModelPassMask	b )

Generated from function MR::operator&=. Parameter a can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_bitand_MR_RenderModelPassMask()

MRC_API MR_RenderModelPassMask MR_bitand_MR_RenderModelPassMask	(	MR_RenderModelPassMask	a,
		MR_RenderModelPassMask	b )

Generated from function MR::operator&.

MR_bitor_assign_MR_RenderModelPassMask()

MRC_API MR_RenderModelPassMask * MR_bitor_assign_MR_RenderModelPassMask	(	MR_RenderModelPassMask *	a,
		MR_RenderModelPassMask	b )

Generated from function MR::operator|=. Parameter a can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_bitor_MR_RenderModelPassMask()

MRC_API MR_RenderModelPassMask MR_bitor_MR_RenderModelPassMask	(	MR_RenderModelPassMask	a,
		MR_RenderModelPassMask	b )

Generated from function MR::operator|.

MR_compl_MR_RenderModelPassMask()

MRC_API MR_RenderModelPassMask MR_compl_MR_RenderModelPassMask

(

MR_RenderModelPassMask

a

)

Generated from function MR::operator~.

MR_mul_assign_MR_RenderModelPassMask_bool()

MRC_API MR_RenderModelPassMask * MR_mul_assign_MR_RenderModelPassMask_bool	(	MR_RenderModelPassMask *	a,
		bool	b )

Generated from function MR::operator*=. Parameter a can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_mul_bool_MR_RenderModelPassMask()

MRC_API MR_RenderModelPassMask MR_mul_bool_MR_RenderModelPassMask	(	bool	a,
		MR_RenderModelPassMask	b )

Generated from function MR::operator*.

MR_mul_MR_RenderModelPassMask_bool()

MRC_API MR_RenderModelPassMask MR_mul_MR_RenderModelPassMask_bool	(	MR_RenderModelPassMask	a,
		bool	b )

Generated from function MR::operator*.

MR_TransparencyMode_AssignFromAnother()

MRC_API MR_TransparencyMode * MR_TransparencyMode_AssignFromAnother	(	MR_TransparencyMode *	_this,
		const MR_TransparencyMode *	_other )

Generated from method MR::TransparencyMode::operator=. Parameter _this can not be null. It is a single object. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in this object. The returned pointer will never be null. It is non-owning, do NOT destroy it. When this function is called, this object will drop any object references it had previously.

MR_TransparencyMode_Construct_1()

MRC_API MR_TransparencyMode * MR_TransparencyMode_Construct_1

(

bool

alphaSort

)

Generated from constructor MR::TransparencyMode::TransparencyMode. Never returns null. Returns an instance allocated on the heap! Must call MR_TransparencyMode_Destroy() to free it when you're done using it.

MR_TransparencyMode_Construct_3()

MRC_API MR_TransparencyMode * MR_TransparencyMode_Construct_3	(	unsigned int	bgDepthTexId,
		unsigned int	fgColorTexId,
		unsigned int	fgDepthTexId )

Generated from constructor MR::TransparencyMode::TransparencyMode. The reference to the parameter bgDepthTexId might be preserved in the constructed object. The reference to the parameter fgColorTexId might be preserved in the constructed object. The reference to the parameter fgDepthTexId might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_TransparencyMode_Destroy() to free it when you're done using it.

MR_TransparencyMode_ConstructFromAnother()

MRC_API MR_TransparencyMode * MR_TransparencyMode_ConstructFromAnother

(

const MR_TransparencyMode *

_other

)

Generated from constructor MR::TransparencyMode::TransparencyMode. Parameter _other can not be null. It is a single object. The reference to things referred to by the parameter _other (if any) might be preserved in the constructed object. Never returns null. Returns an instance allocated on the heap! Must call MR_TransparencyMode_Destroy() to free it when you're done using it.

MR_TransparencyMode_DefaultConstruct()

MRC_API MR_TransparencyMode * MR_TransparencyMode_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_TransparencyMode_Destroy() to free it when you're done using it.

MR_TransparencyMode_DefaultConstructArray()

MRC_API MR_TransparencyMode * MR_TransparencyMode_DefaultConstructArray

(

size_t

num_elems

)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_TransparencyMode_DestroyArray(). Use MR_TransparencyMode_OffsetMutablePtr() and MR_TransparencyMode_OffsetPtr() to access the array elements.

MR_TransparencyMode_Destroy()

MRC_API void MR_TransparencyMode_Destroy

(

const MR_TransparencyMode *

_this

)

Destroys a heap-allocated instance of MR_TransparencyMode. Does nothing if the pointer is null.

MR_TransparencyMode_DestroyArray()

MRC_API void MR_TransparencyMode_DestroyArray

(

const MR_TransparencyMode *

_this

)

Destroys a heap-allocated array of MR_TransparencyMode. Does nothing if the pointer is null.

MR_TransparencyMode_getBGDepthPeelingDepthTextureId()

MRC_API unsigned int MR_TransparencyMode_getBGDepthPeelingDepthTextureId

(

const MR_TransparencyMode *

_this

)

Generated from method MR::TransparencyMode::getBGDepthPeelingDepthTextureId. Parameter _this can not be null. It is a single object.

MR_TransparencyMode_getFGDepthPeelingColorTextureId()

MRC_API unsigned int MR_TransparencyMode_getFGDepthPeelingColorTextureId

(

const MR_TransparencyMode *

_this

)

Generated from method MR::TransparencyMode::getFGDepthPeelingColorTextureId. Parameter _this can not be null. It is a single object.

MR_TransparencyMode_getFGDepthPeelingDepthTextureId()

MRC_API unsigned int MR_TransparencyMode_getFGDepthPeelingDepthTextureId

(

const MR_TransparencyMode *

_this

)

Generated from method MR::TransparencyMode::getFGDepthPeelingDepthTextureId. Parameter _this can not be null. It is a single object.

MR_TransparencyMode_isAlphaSortEnabled()

MRC_API bool MR_TransparencyMode_isAlphaSortEnabled

(

const MR_TransparencyMode *

_this

)

Generated from method MR::TransparencyMode::isAlphaSortEnabled. Parameter _this can not be null. It is a single object.

MR_TransparencyMode_isDepthPeelingEnabled()

MRC_API bool MR_TransparencyMode_isDepthPeelingEnabled

(

const MR_TransparencyMode *

_this

)

Generated from method MR::TransparencyMode::isDepthPeelingEnabled. Parameter _this can not be null. It is a single object.

MR_TransparencyMode_OffsetMutablePtr()

MRC_API MR_TransparencyMode * MR_TransparencyMode_OffsetMutablePtr	(	MR_TransparencyMode *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.

MR_TransparencyMode_OffsetPtr()

MRC_API const MR_TransparencyMode * MR_TransparencyMode_OffsetPtr	(	const MR_TransparencyMode *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element. The reference to the parameter ptr might be preserved in the return value.