OGLplus (0.52.0) a C++ wrapper for OpenGL

A filter creating a normal-map/height-map from a height map image. More...

#include </home/chochlik/devel/oglplus/include/oglplus/images/normal_map.hpp>

Inheritance diagram for oglplus::images::NormalMap:
Collaboration diagram for oglplus::images::NormalMap:

Public Types

typedef FromComponentI< 0 > FromRed
 Extractor selecting the Red component of the input image.
 
typedef FromComponentI< 1 > FromGreen
 Extractor selecting the Green component of the input image.
 
typedef FromComponentI< 2 > FromBlue
 Extractor selecting the Blue component of the input image.
 
typedef FromComponentI< 3 > FromAlpha
 Extractor selecting the Alpha component of the input image.
 

Public Member Functions

template<typename Extractor >
 NormalMap (const Image &input, Extractor extractor=Extractor())
 Creates a normal-map from the input height-map image. More...
 
GLsizei Dimension (std::size_t i) const
 Returns the i-th dimension of the image. More...
 
GLsizei Width (void) const
 Returns the width of the image.
 
GLsizei Height (void) const
 Returns the height of the image.
 
GLsizei Depth (void) const
 Returns the depth of the image.
 
GLsizei Channels (void) const
 Returns the number of channels.
 
PixelDataType Type (void) const
 Returns the pixel data type.
 
PixelDataFormat Format (void) const
 Return the pixel data format.
 
PixelDataInternalFormat InternalFormat (void) const
 Return a suitable pixel data internal format.
 
template<typename T >
const TData (void) const
 Returns a pointer to the data.
 
const void * RawData (void) const
 Returns an untyped pointer to the data.
 
std::size_t DataSize (void) const
 Returns the size of data in bytes.
 
Vector< double, 4 > Pixel (GLsizei width, GLsizei height, GLsizei depth) const
 Returns the pixel at the specified coordinates.
 
double Component (GLsizei width, GLsizei height, GLsizei depth, GLsizei component) const
 Returns the component of the pixel at the specified coordinates.
 
template<typename T >
T ComponentAs (GLsizei width, GLsizei height, GLsizei depth, GLsizei component) const
 Returns the component of the pixel at the specified coordinates.
 

Detailed Description

A filter creating a normal-map/height-map from a height map image.

Constructor & Destructor Documentation

template<typename Extractor >
oglplus::images::NormalMap::NormalMap ( const Image input,
Extractor  extractor = Extractor() 
)

Creates a normal-map from the input height-map image.

Parameters
inputthe height-map image to be filtered
extractorthe height map color component extractor (by default the RED component of the image is used as the height-map value used in normal-map calculation).

Member Function Documentation

GLsizei oglplus::images::Image::Dimension ( std::size_t  i) const
inherited

Returns the i-th dimension of the image.

0: Width 1: Height 2: Depth 3: Channels

References oglplus::images::Image::Channels(), oglplus::images::Image::Depth(), oglplus::images::Image::Height(), and oglplus::images::Image::Width().


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

Copyright © 2010-2014 Matúš Chochlík, University of Žilina, Žilina, Slovakia.
<matus.chochlik -at- fri.uniza.sk>
<chochlik -at -gmail.com>
Documentation generated on Mon Sep 22 2014 by Doxygen (version 1.8.6).