std_optional_MR_MeshOrPoints.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_MeshOrPoints	MR_MeshOrPoints
typedef struct MR_std_optional_MR_MeshOrPoints	MR_std_optional_MR_MeshOrPoints

Functions
MRC_API MR_std_optional_MR_MeshOrPoints *	MR_std_optional_MR_MeshOrPoints_ConstructFromAnother (const MR_std_optional_MR_MeshOrPoints *other)
MRC_API MR_std_optional_MR_MeshOrPoints *	MR_std_optional_MR_MeshOrPoints_ConstructFrom (const MR_MeshOrPoints *other)
MRC_API void	MR_std_optional_MR_MeshOrPoints_AssignFromAnother (MR_std_optional_MR_MeshOrPoints *_this, const MR_std_optional_MR_MeshOrPoints *other)
MRC_API void	MR_std_optional_MR_MeshOrPoints_AssignFrom (MR_std_optional_MR_MeshOrPoints *_this, const MR_MeshOrPoints *other)
MRC_API void	MR_std_optional_MR_MeshOrPoints_Destroy (const MR_std_optional_MR_MeshOrPoints *_this)
	Destroys a heap-allocated instance of MR_std_optional_MR_MeshOrPoints. Does nothing if the pointer is null.
MRC_API void	MR_std_optional_MR_MeshOrPoints_DestroyArray (const MR_std_optional_MR_MeshOrPoints *_this)
	Destroys a heap-allocated array of MR_std_optional_MR_MeshOrPoints. Does nothing if the pointer is null.
MRC_API const MR_std_optional_MR_MeshOrPoints *	MR_std_optional_MR_MeshOrPoints_OffsetPtr (const MR_std_optional_MR_MeshOrPoints *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.
MRC_API MR_std_optional_MR_MeshOrPoints *	MR_std_optional_MR_MeshOrPoints_OffsetMutablePtr (MR_std_optional_MR_MeshOrPoints *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.
MRC_API const MR_MeshOrPoints *	MR_std_optional_MR_MeshOrPoints_Value (const MR_std_optional_MR_MeshOrPoints *_this)
MRC_API MR_MeshOrPoints *	MR_std_optional_MR_MeshOrPoints_MutableValue (MR_std_optional_MR_MeshOrPoints *_this)

Typedef Documentation

MR_MeshOrPoints

typedef struct MR_MeshOrPoints MR_MeshOrPoints

MR_std_optional_MR_MeshOrPoints

typedef struct MR_std_optional_MR_MeshOrPoints MR_std_optional_MR_MeshOrPoints

Stores either a single MR::MeshOrPoints or nothing. Supported MR_PassBy modes: MR_PassBy_Copy, MR_PassBy_Move, (and MR_PassBy_DefaultArgument and MR_PassBy_NoObject if supported by the callee).

Function Documentation

MR_std_optional_MR_MeshOrPoints_AssignFrom()

MRC_API void MR_std_optional_MR_MeshOrPoints_AssignFrom	(	MR_std_optional_MR_MeshOrPoints *	_this,
		const MR_MeshOrPoints *	other )

Assigns the contents. Parameter _this can not be null. It is a single object. Parameter other is a single object. Parameter other is optional. To keep it empty, pass a null pointer.

MR_std_optional_MR_MeshOrPoints_AssignFromAnother()

MRC_API void MR_std_optional_MR_MeshOrPoints_AssignFromAnother	(	MR_std_optional_MR_MeshOrPoints *	_this,
		const MR_std_optional_MR_MeshOrPoints *	other )

Assigns the contents from another instance. Both objects remain alive after the call. Parameter _this can not be null. It is a single object. Parameter other can not be null. It is a single object.

MR_std_optional_MR_MeshOrPoints_ConstructFrom()

MRC_API MR_std_optional_MR_MeshOrPoints * MR_std_optional_MR_MeshOrPoints_ConstructFrom

(

const MR_MeshOrPoints *

other

)

Constructs a new instance. Parameter other is a single object. Parameter other is optional. To keep it empty, pass a null pointer. Never returns null. Returns an instance allocated on the heap! Must call MR_std_optional_MR_MeshOrPoints_Destroy() to free it when you're done using it.

MR_std_optional_MR_MeshOrPoints_ConstructFromAnother()

MRC_API MR_std_optional_MR_MeshOrPoints * MR_std_optional_MR_MeshOrPoints_ConstructFromAnother

(

const MR_std_optional_MR_MeshOrPoints *

other

)

Constructs a copy of another instance. The source remains alive. Parameter other can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_std_optional_MR_MeshOrPoints_Destroy() to free it when you're done using it.

MR_std_optional_MR_MeshOrPoints_Destroy()

MRC_API void MR_std_optional_MR_MeshOrPoints_Destroy

(

const MR_std_optional_MR_MeshOrPoints *

_this

)

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

MR_std_optional_MR_MeshOrPoints_DestroyArray()

MRC_API void MR_std_optional_MR_MeshOrPoints_DestroyArray

(

const MR_std_optional_MR_MeshOrPoints *

_this

)

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

MR_std_optional_MR_MeshOrPoints_MutableValue()

MRC_API MR_MeshOrPoints * MR_std_optional_MR_MeshOrPoints_MutableValue

(

MR_std_optional_MR_MeshOrPoints *

_this

)

The stored element or null if none, mutable. Parameter _this can not be null. It is a single object.

MR_std_optional_MR_MeshOrPoints_OffsetMutablePtr()

MRC_API MR_std_optional_MR_MeshOrPoints * MR_std_optional_MR_MeshOrPoints_OffsetMutablePtr	(	MR_std_optional_MR_MeshOrPoints *	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.

MR_std_optional_MR_MeshOrPoints_OffsetPtr()

MRC_API const MR_std_optional_MR_MeshOrPoints * MR_std_optional_MR_MeshOrPoints_OffsetPtr	(	const MR_std_optional_MR_MeshOrPoints *	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.

MR_std_optional_MR_MeshOrPoints_Value()

MRC_API const MR_MeshOrPoints * MR_std_optional_MR_MeshOrPoints_Value

(

const MR_std_optional_MR_MeshOrPoints *

_this

)

The stored element or null if none, read-only. Parameter _this can not be null. It is a single object.