PixelLightAPI  .
Static Public Member Functions | Static Public Attributes
PLMath::Half Class Reference

Static helper class for the half data type (16 bit floating point) More...

#include <Half.h>

List of all members.

Static Public Member Functions

static bool IsZero (PLCore::uint16 nHalf)
 Returns whether or not the given half value is zero.
static bool IsNegative (PLCore::uint16 nHalf)
 Returns whether or not the given half value is negative.
static bool IsNotANumber (PLCore::uint16 nHalf)
 Returns whether or not the given half value is not a number (NAN)
static bool IsFinite (PLCore::uint16 nHalf)
 Returns whether or not the given half value is finite.
static bool IsInfinity (PLCore::uint16 nHalf)
 Returns whether or not the given half value is infinity.
static bool IsNormalized (PLCore::uint16 nHalf)
 Returns whether or not the given half value is normalized.
static bool IsDenormalized (PLCore::uint16 nHalf)
 Returns whether or not the given half value is de-normalized.
static PLMATH_API float ToFloat (PLCore::uint16 nHalf)
 Converts a given half value into a float value.
static PLMATH_API PLCore::uint16 FromFloat (float fFloat)
 Converts a given float value into a half value.

Static Public Attributes

static PLMATH_API const
PLCore::uint16 
Zero
static PLMATH_API const
PLCore::uint16 
One
static PLMATH_API const float SmallestPositive
static PLMATH_API const float SmallestPositiveNormalized
static PLMATH_API const float LargestPositive
static PLMATH_API const float Epsilon

Detailed Description

Static helper class for the half data type (16 bit floating point)

Note:

Member Function Documentation

bool PLMath::Half::IsZero ( PLCore::uint16  nHalf) [inline, static]

Returns whether or not the given half value is zero.

Parameters:
[in]nHalfHalf value to check
Returns:
'true' if the given half value is zero, else 'false'
bool PLMath::Half::IsNegative ( PLCore::uint16  nHalf) [inline, static]

Returns whether or not the given half value is negative.

Parameters:
[in]nHalfHalf value to check
Returns:
'true' if the given half value is negative, else 'false'
bool PLMath::Half::IsNotANumber ( PLCore::uint16  nHalf) [inline, static]

Returns whether or not the given half value is not a number (NAN)

Parameters:
[in]nHalfHalf value to check
Returns:
'true' if the given half value is not a number, else 'false'
bool PLMath::Half::IsFinite ( PLCore::uint16  nHalf) [inline, static]

Returns whether or not the given half value is finite.

Parameters:
[in]nHalfHalf value to check
Returns:
'true' if the given half value is finite, else 'false'
bool PLMath::Half::IsInfinity ( PLCore::uint16  nHalf) [inline, static]

Returns whether or not the given half value is infinity.

Parameters:
[in]nHalfHalf value to check
Returns:
'true' if the given half value is infinity, else 'false'
bool PLMath::Half::IsNormalized ( PLCore::uint16  nHalf) [inline, static]

Returns whether or not the given half value is normalized.

Parameters:
[in]nHalfHalf value to check
Returns:
'true' if the given half value is normalized, else 'false'
bool PLMath::Half::IsDenormalized ( PLCore::uint16  nHalf) [inline, static]

Returns whether or not the given half value is de-normalized.

Parameters:
[in]nHalfHalf value to check
Returns:
'true' if the given half value is de-normalized, else 'false'
static PLMATH_API float PLMath::Half::ToFloat ( PLCore::uint16  nHalf) [static]

Converts a given half value into a float value.

Parameters:
[in]nHalfHalf value to convert
Returns:
The given half value as float
static PLMATH_API PLCore::uint16 PLMath::Half::FromFloat ( float  fFloat) [static]

Converts a given float value into a half value.

Parameters:
[in]fFloatFloat value to convert
Returns:
The given float value as half

Member Data Documentation

PLMATH_API const PLCore::uint16 PLMath::Half::Zero [static]

Representation of 0.0

PLMATH_API const PLCore::uint16 PLMath::Half::One [static]

Representation of 1.0

PLMATH_API const float PLMath::Half::SmallestPositive [static]

Smallest positive half (5.96046448e-08f)

PLMATH_API const float PLMath::Half::SmallestPositiveNormalized [static]

Smallest positive normalized half (6.10351562e-05f)

PLMATH_API const float PLMath::Half::LargestPositive [static]

Largest positive half (65504.0f)

PLMATH_API const float PLMath::Half::Epsilon [static]

Smallest positive epsilon for which 1+e!=1 (0.00097656f)


The documentation for this class was generated from the following files:


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:35
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported