NVIDIA Iray: Math API nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::math::Color_struct Struct Reference

Generic storage class template for an RGBA color representation storing four floating points elements. More...

+ Inheritance diagram for mi::math::Color_struct:

Public Attributes

Float32 r
 Red color component. More...
 
Float32 g
 Green color component. More...
 
Float32 b
 Blue color component. More...
 
Float32 a
 Alpha value, 0.0 is fully transparent and 1.0 is opaque; value can lie outside that range. More...
 

Detailed Description

Generic storage class template for an RGBA color representation storing four floating points elements.

Used as base class for the mi::math::Color class.

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

All elements are usually in the range [0,1], but they may lie outside that range and they may also be negative.

This class provides storage for four elements of type mi::Float32. These elements can be accessed as data members named r, g, b, and a. For array-like access of these elements, there order in memory is rgba.

This class contains only the data and no member functions. See mi::math::Color for more.

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

Member Data Documentation

Float32 mi::math::Color_struct::a

Alpha value, 0.0 is fully transparent and 1.0 is opaque; value can lie outside that range.

Float32 mi::math::Color_struct::b

Blue color component.

Float32 mi::math::Color_struct::g

Green color component.

Float32 mi::math::Color_struct::r

Red color component.