Ogre::ColourValue - Ogre::ColourValue documentation


Ogre documentation Contained in the Ogre distribution.

Index


Code Index:

NAME

Top

Ogre::ColourValue

SYNOPSIS

Top

  use Ogre;
  use Ogre::ColourValue;
  # (for now see examples/README.txt)

DESCRIPTION

Top

See the online API documentation athttp://www.ogre3d.org/docs/api/html/classOgre_1_1ColourValue.html

Note: this Perl binding is currently experimental and subject to API changes.

CLASS METHODS

Top

Ogre::ColourValue->new($red=1, $green=1, $blue=1, $alpha=1)

Parameter types

$red=1 : Real
$green=1 : Real
$blue=1 : Real
$alpha=1 : Real

Returns

ColourValue *

Ogre::ColourValue->DESTROY()

This method is called automatically; don't call it yourself.

\&eq_xs

This is an operator overload method; don't call it yourself.

INSTANCE METHODS

Top

$obj->saturate()

Returns

void

$obj->setHSB($hue, $saturation, $brightness)

Parameter types

$hue : Real
$saturation : Real
$brightness : Real

Returns

void

$obj->r()

Returns

Real

$obj->g()

Returns

Real

$obj->b()

Returns

Real

$obj->a()

Returns

Real

AUTHOR

Top

Scott Lanning <slanning@cpan.org>

For licensing information, see README.txt .


Ogre documentation Contained in the Ogre distribution.

package Ogre::ColourValue;

use strict;
use warnings;

# xxx: this should be in XS, but I can't get it to work
use overload
  '==' => \&eq_xs,
  '!=' => \&ne_xs,
  ;


1;

__END__