std_optional_MR_VertMap.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct MR_VertMap	MR_VertMap
typedef struct MR_std_optional_MR_VertMap	MR_std_optional_MR_VertMap

Functions
MRC_API MR_std_optional_MR_VertMap *	MR_std_optional_MR_VertMap_DefaultConstruct (void)
MRC_API MR_std_optional_MR_VertMap *	MR_std_optional_MR_VertMap_DefaultConstructArray (size_t num_elems)
MRC_API MR_std_optional_MR_VertMap *	MR_std_optional_MR_VertMap_ConstructFromAnother (MR_PassBy other_pass_by, MR_std_optional_MR_VertMap *other)
MRC_API MR_std_optional_MR_VertMap *	MR_std_optional_MR_VertMap_ConstructFrom (MR_PassBy other_pass_by, MR_VertMap *other)
MRC_API void	MR_std_optional_MR_VertMap_AssignFromAnother (MR_std_optional_MR_VertMap *_this, MR_PassBy other_pass_by, MR_std_optional_MR_VertMap *other)
MRC_API void	MR_std_optional_MR_VertMap_AssignFrom (MR_std_optional_MR_VertMap *_this, MR_PassBy other_pass_by, MR_VertMap *other)
MRC_API void	MR_std_optional_MR_VertMap_Destroy (const MR_std_optional_MR_VertMap *_this)
	Destroys a heap-allocated instance of MR_std_optional_MR_VertMap. Does nothing if the pointer is null.
MRC_API void	MR_std_optional_MR_VertMap_DestroyArray (const MR_std_optional_MR_VertMap *_this)
	Destroys a heap-allocated array of MR_std_optional_MR_VertMap. Does nothing if the pointer is null.
MRC_API const MR_std_optional_MR_VertMap *	MR_std_optional_MR_VertMap_OffsetPtr (const MR_std_optional_MR_VertMap *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_VertMap *	MR_std_optional_MR_VertMap_OffsetMutablePtr (MR_std_optional_MR_VertMap *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_VertMap *	MR_std_optional_MR_VertMap_Value (const MR_std_optional_MR_VertMap *_this)
MRC_API MR_VertMap *	MR_std_optional_MR_VertMap_MutableValue (MR_std_optional_MR_VertMap *_this)

Typedef Documentation

MR_std_optional_MR_VertMap

typedef struct MR_std_optional_MR_VertMap MR_std_optional_MR_VertMap

Stores either a single MR::VertMap or nothing. 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).

MR_VertMap

typedef struct MR_VertMap MR_VertMap

Function Documentation

MR_std_optional_MR_VertMap_AssignFrom()

MRC_API void MR_std_optional_MR_VertMap_AssignFrom	(	MR_std_optional_MR_VertMap *	_this,
		MR_PassBy	other_pass_by,
		MR_VertMap *	other )

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

MR_std_optional_MR_VertMap_AssignFromAnother()

MRC_API void MR_std_optional_MR_VertMap_AssignFromAnother	(	MR_std_optional_MR_VertMap *	_this,
		MR_PassBy	other_pass_by,
		MR_std_optional_MR_VertMap *	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.

MR_std_optional_MR_VertMap_ConstructFrom()

MRC_API MR_std_optional_MR_VertMap * MR_std_optional_MR_VertMap_ConstructFrom	(	MR_PassBy	other_pass_by,
		MR_VertMap *	other )

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

MR_std_optional_MR_VertMap_ConstructFromAnother()

MRC_API MR_std_optional_MR_VertMap * MR_std_optional_MR_VertMap_ConstructFromAnother	(	MR_PassBy	other_pass_by,
		MR_std_optional_MR_VertMap *	other )

Constructs a copy of another instance. The source remains alive. Never returns null. Returns an instance allocated on the heap! Must call MR_std_optional_MR_VertMap_Destroy() to free it when you're done using it.

MR_std_optional_MR_VertMap_DefaultConstruct()

MRC_API MR_std_optional_MR_VertMap * MR_std_optional_MR_VertMap_DefaultConstruct

(

void

)

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

MR_std_optional_MR_VertMap_DefaultConstructArray()

MRC_API MR_std_optional_MR_VertMap * MR_std_optional_MR_VertMap_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_std_optional_MR_VertMap_DestroyArray(). Use MR_std_optional_MR_VertMap_OffsetMutablePtr() and MR_std_optional_MR_VertMap_OffsetPtr() to access the array elements.

MR_std_optional_MR_VertMap_Destroy()

MRC_API void MR_std_optional_MR_VertMap_Destroy

(

const MR_std_optional_MR_VertMap *

_this

)

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

MR_std_optional_MR_VertMap_DestroyArray()

MRC_API void MR_std_optional_MR_VertMap_DestroyArray

(

const MR_std_optional_MR_VertMap *

_this

)

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

MR_std_optional_MR_VertMap_MutableValue()

MRC_API MR_VertMap * MR_std_optional_MR_VertMap_MutableValue

(

MR_std_optional_MR_VertMap *

_this

)

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

MR_std_optional_MR_VertMap_OffsetMutablePtr()

MRC_API MR_std_optional_MR_VertMap * MR_std_optional_MR_VertMap_OffsetMutablePtr	(	MR_std_optional_MR_VertMap *	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_VertMap_OffsetPtr()

MRC_API const MR_std_optional_MR_VertMap * MR_std_optional_MR_VertMap_OffsetPtr	(	const MR_std_optional_MR_VertMap *	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_VertMap_Value()

MRC_API const MR_VertMap * MR_std_optional_MR_VertMap_Value

(

const MR_std_optional_MR_VertMap *

_this

)

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