Material Definition Language API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Internal Storage Class for Math Vector

Storage class for math vectors with support for x, y, z, and w members for appropriate dimensions. More...

Classes

struct  mi::math::Vector_struct< T, DIM >
 Generic storage class template for math vector representations storing DIM elements of type T. More...
 
struct  mi::math::Vector_struct< T, 1 >
 Specialization for dimension 1 to create x member. More...
 
struct  mi::math::Vector_struct< T, 2 >
 Specialization for dimension 2 to create x and y member. More...
 
struct  mi::math::Vector_struct< T, 3 >
 Specialization for dimension 3 to create x, y, and z members. More...
 
struct  mi::math::Vector_struct< T, 4 >
 Specialization for dimension 4 to create x, y, z, and w members. More...
 

Functions

template<typename T , Size DIM>
T * mi::math::vector_base_ptr (Vector_struct< T, DIM > &vec)
 Returns the base pointer to the vector data. More...
 
template<typename T , Size DIM>
const T * mi::math::vector_base_ptr (const Vector_struct< T, DIM > &vec)
 Returns the base pointer to the vector data. More...
 
template<typename T >
T * mi::math::vector_base_ptr (Vector_struct< T, 1 > &vec)
 Returns the base pointer to the vector data, specialization for DIM==1. More...
 
template<typename T >
const T * mi::math::vector_base_ptr (const Vector_struct< T, 1 > &vec)
 Returns the base pointer to the vector data, specialization for DIM==1. More...
 
template<typename T >
T * mi::math::vector_base_ptr (Vector_struct< T, 2 > &vec)
 Returns the base pointer to the vector data, specialization for DIM==2. More...
 
template<typename T >
const T * mi::math::vector_base_ptr (const Vector_struct< T, 2 > &vec)
 Returns the base pointer to the vector data, specialization for DIM==2. More...
 
template<typename T >
T * mi::math::vector_base_ptr (Vector_struct< T, 3 > &vec)
 Returns the base pointer to the vector data, specialization for DIM==3. More...
 
template<typename T >
const T * mi::math::vector_base_ptr (const Vector_struct< T, 3 > &vec)
 Returns the base pointer to the vector data, specialization for DIM==3. More...
 
template<typename T >
T * mi::math::vector_base_ptr (Vector_struct< T, 4 > &vec)
 Returns the base pointer to the vector data, specialization for DIM==4. More...
 
template<typename T >
const T * mi::math::vector_base_ptr (const Vector_struct< T, 4 > &vec)
 Returns the base pointer to the vector data, specialization for DIM==4. More...
 

Detailed Description

Storage class for math vectors with support for x, y, z, and w members for appropriate dimensions.

Use the mi::math::Vector template in your programs and this storage class only if you need a POD type, for example for parameter passing.

Include File:
#include <mi/math/vector.h>

Function Documentation

template<typename T , Size DIM>
T* mi::math::vector_base_ptr ( Vector_struct< T, DIM > &  vec)
inline

Returns the base pointer to the vector data.

template<typename T , Size DIM>
const T* mi::math::vector_base_ptr ( const Vector_struct< T, DIM > &  vec)
inline

Returns the base pointer to the vector data.

template<typename T >
T* mi::math::vector_base_ptr ( Vector_struct< T, 1 > &  vec)
inline

Returns the base pointer to the vector data, specialization for DIM==1.

template<typename T >
const T* mi::math::vector_base_ptr ( const Vector_struct< T, 1 > &  vec)
inline

Returns the base pointer to the vector data, specialization for DIM==1.

template<typename T >
T* mi::math::vector_base_ptr ( Vector_struct< T, 2 > &  vec)
inline

Returns the base pointer to the vector data, specialization for DIM==2.

template<typename T >
const T* mi::math::vector_base_ptr ( const Vector_struct< T, 2 > &  vec)
inline

Returns the base pointer to the vector data, specialization for DIM==2.

template<typename T >
T* mi::math::vector_base_ptr ( Vector_struct< T, 3 > &  vec)
inline

Returns the base pointer to the vector data, specialization for DIM==3.

template<typename T >
const T* mi::math::vector_base_ptr ( const Vector_struct< T, 3 > &  vec)
inline

Returns the base pointer to the vector data, specialization for DIM==3.

template<typename T >
T* mi::math::vector_base_ptr ( Vector_struct< T, 4 > &  vec)
inline

Returns the base pointer to the vector data, specialization for DIM==4.

template<typename T >
const T* mi::math::vector_base_ptr ( const Vector_struct< T, 4 > &  vec)
inline

Returns the base pointer to the vector data, specialization for DIM==4.