xforms.h File Reference

OSKI-Lua transformation module. More...

#include <oski/matrix.h>
#include <oski/lua.h>

Go to the source code of this file.

Defines
#define	INC_OSKI_XFORMS_H
	oski/xforms.h included.
Name mangling.
#define	oski_ReplaceTunedMatRepr   MANGLE_(oski_ReplaceTunedMatRepr)
#define	oski_FreeInputMatRepr   MANGLE_(oski_FreeInputMatRepr)
Functions
int	oski_ReplaceTunedMatRepr (oski_matrix_t A, oski_matspecific_t *new_mat, const char *xforms)
	Replace a matrix's tuned representation with a new one.
int	oski_FreeInputMatRepr (oski_matrix_t A)
	If the given matrix has a valid tuned representation and does not share its input representation, then this routine destroys the input matrix representation.

---

Detailed Description

OSKI-Lua transformation module.

---

Define Documentation

#define INC_OSKI_XFORMS_H

oski/xforms.h included.

---

Function Documentation

int oski_FreeInputMatRepr

(

oski_matrix_t

A

)

If the given matrix has a valid tuned representation and does not share its input representation, then this routine destroys the input matrix representation.

Returns:

An error code on error. Otherwise, this function returns 0, regardless of whether the input matrix representation could be legally destroyed.

Todo:

Possible leak?

References ERR_BAD_MAT, oski_matstruct_t::input_mat, INVALID_ID, INVALID_MAT, oski_matstruct_t::is_shared, OSKI_MATTYPEID_METHOD, oski_PrintDebugMessage(), oski_matspecific_t::repr, oski_matstruct_t::tuned_mat, and oski_matspecific_t::type_id.

int oski_ReplaceTunedMatRepr	(	oski_matrix_t	A,
		oski_matspecific_t *	new_mat,
		const char *	xforms
	)

Replace a matrix's tuned representation with a new one.

Parameters:

[in,out]	A	Matrix whose tuned representation is to be changed.
[in]	new_mat	The new matrix representation.
[in]	xforms	The corresponding transformation string used to create 'new_mat'.

Returns:

0 on success, or an error code. Does not call the error handler.

If new_mat points to A's tuned matrix representation, this function immediately returns 0.

If A is invalid, this function returns ERR_BAD_MAT.

References ERR_BAD_MAT, INVALID_ID, INVALID_MAT, oski_DuplicateString(), oski_Free, OSKI_MATTYPEID_METHOD, oski_PrintDebugMessage(), oski_matspecific_t::repr, oski_matstruct_t::tuned_mat, oski_matstruct_t::tuned_xforms, and oski_matspecific_t::type_id.