mattypes_internal.h File Reference

Defines a matrix type record. More...

#include <oski/modloader.h>

Go to the source code of this file.

Data Structures
struct	tagBebop_mattype_t
	Matrix type record. More...
Defines
#define	INC_OSKI_MATTYPE_INTERNAL_H
	mattype_internal.h has been included.
Typedefs
typedef struct tagBebop_mattype_t	oski_mattype_t
	Matrix type record.
Functions
const oski_mattype_t *	oski_FindMatTypeRecord (oski_id_t id)
	Find a matrix type record (FOR INTERNAL USE ONLY).
void	oski_DisplayMatTypeInfo (const oski_mattype_t *record, FILE *fp)
	Display a matrix type record (FOR DEBUGGING ONLY).
size_t	oski_GetNumMatTypes (void)
	Returns the total number of registered matrix types.

---

Detailed Description

Defines a matrix type record.

This file is used for debugging only, and should not be used by end-users.

This file depends on oski/modloader.h

---

Define Documentation

#define INC_OSKI_MATTYPE_INTERNAL_H

mattype_internal.h has been included.

---

Typedef Documentation

typedef struct tagBebop_mattype_t oski_mattype_t

Matrix type record.

A "matrix type" is a particular storage format, instantiated with a particular concrete integer index type and non-zero value type. In addition, this record stores a pointer to the module defining the type.

---

Function Documentation

void oski_DisplayMatTypeInfo	(	const oski_mattype_t *	record,
		FILE *	fp
	)

Display a matrix type record (FOR DEBUGGING ONLY).

Parameters:

[in]	record	Record to display.
[in,out]	fp	File pointer for debugging message.

References tagBebop_scalinfo_t::id, tagBebop_mattype_t::id_index_type, tagBebop_mattype_t::id_value_type, INVALID_ID, tagBebop_scalinfo_t::name, oski_DisplayMatTypeInfo(), oski_LookupScalarIndexInfo(), and oski_LookupScalarValueInfo().

Referenced by oski_DisplayMatTypeInfo().

const oski_mattype_t* oski_FindMatTypeRecord

(

oski_id_t

id

)

Find a matrix type record (FOR INTERNAL USE ONLY).

Parameters:

[in]

id

Matrix type id.

Returns:

Returns a pointer to the type record if registered, or NULL otherwise. Returns NULL immediately if id == INVALID_ID.

References tagBebop_mattype_t::id, INVALID_ID, oski_FindMatTypeRecord(), oski_GetNumMatTypes(), and simplelist_GetElem().

Referenced by CreateLuaMatObj(), oski_FindMatTypeRecord(), oski_LookupMatTypeIdMethod(), RegisterLuaMatTypes(), and ToStringLuaMat().