# Visualization Library

A lightweight C++ OpenGL middleware for 2D/3D graphics

[Home] [Tutorials] [All Classes] [Grouped Classes]

Public Member Functions | Protected Attributes

# vl::PixelTransfer Class Reference

RenderState wrapping the OpenGL function glPixelTransfer(), see also http://www.opengl.org/sdk/docs/man/xhtml/glPixelTransfer.xml for more information. More...

`#include <Shader.hpp>`

Inheritance diagram for vl::PixelTransfer:

List of all members.

## Public Member Functions

| PixelTransfer ()
virtual ERenderState | type () const
virtual void | apply (int index, const Camera *, OpenGLContext *ctx) const
| The parameter cameara is NULL if we are disabling the state, non-NULL if we are enabling it.
bool | mapColor () const
bool | mapStencil () const
int | indexShift () const
int | indexOffset () const
float | redScale () const
float | greenScale () const
float | blueScale () const
float | alphaScale () const
float | depthScale () const
float | redBias () const
float | greenBias () const
float | blueBias () const
float | alphaBias () const
float | depthBias () const
float | postColorMatrixRedScale () const
float | postColorMatrixGreenScale () const
float | postColorMatrixBlueScale () const
float | postColorMatrixAlphaScale () const
float | postColorMatrixRedBias () const
float | postColorMatrixGreenBias () const
float | postColorMatrixBlueBias () const
float | postColorMatrixAlphaBias () const
float | postConvolutionRedScale () const
float | postConvolutionGreenScale () const
float | postConvolutionBlueScale () const
float | postConvolutionAlphaScale () const
float | postConvolutionRedBias () const
float | postConvolutionGreenBias () const
float | postConvolutionBlueBias () const
float | postConvolutionAlphaBias () const
void | setMapColor (bool map_color)
void | setMapStencil (bool map_stencil)
void | setIndexShift (int index_shift)
void | setIndexOffset (int index_offset)
void | setRedScale (float red_scale)
void | setGreenScale (float green_scale)
void | setBlueScale (float blue_scale)
void | setAlphaScale (float alpha_scale)
void | setDepthScale (float depth_scale)
void | setRedBias (float red_bias)
void | setGreenBias (float green_bias)
void | setBlueBias (float blue_bias)
void | setAlphaBias (float alpha_bias)
void | setDepthBias (float depth_bias)
void | setPostColorMatrixRedScale (float scale)
void | setPostColorMatrixGreenScale (float scale)
void | setPostColorMatrixBlueScale (float scale)
void | setPostColorMatrixAlphaScale (float scale)
void | setPostColorMatrixRedBias (float bias)
void | setPostColorMatrixGreenBias (float bias)
void | setPostColorMatrixBlueBias (float bias)
void | setPostColorMatrixAlphaBias (float bias)
void | setPostConvolutionRedScale (float scale)
void | setPostConvolutionGreenScale (float scale)
void | setPostConvolutionBlueScale (float scale)
void | setPostConvolutionAlphaScale (float scale)
void | setPostConvolutionRedBias (float bias)
void | setPostConvolutionGreenBias (float bias)
void | setPostConvolutionBlueBias (float bias)
void | setPostConvolutionAlphaBias (float bias)
virtual ref< RenderState > | clone () const

## Protected Attributes

bool | mMapColor
bool | mMapStencil
int | mIndexShift
int | mIndexOffset
float | mRedScale
float | mGreenScale
float | mBlueScale
float | mAlphaScale
float | mDepthScale
float | mRedBias
float | mGreenBias
float | mBlueBias
float | mAlphaBias
float | mDepthBias
float | mPostColorMatrixRedScale
float | mPostColorMatrixGreenScale
float | mPostColorMatrixBlueScale
float | mPostColorMatrixAlphaScale
float | mPostColorMatrixRedBias
float | mPostColorMatrixGreenBias
float | mPostColorMatrixBlueBias
float | mPostColorMatrixAlphaBias
float | mPostConvolutionRedScale
float | mPostConvolutionGreenScale
float | mPostConvolutionBlueScale
float | mPostConvolutionAlphaScale
float | mPostConvolutionRedBias
float | mPostConvolutionGreenBias
float | mPostConvolutionBlueBias
float | mPostConvolutionAlphaBias

## Detailed Description

RenderState wrapping the OpenGL function glPixelTransfer(), see also http://www.opengl.org/sdk/docs/man/xhtml/glPixelTransfer.xml for more information.

See also:
  Shader, Effect, Actor

Definition at line 196 of file Shader.hpp.

## Constructor & Destructor Documentation

vl::PixelTransfer::PixelTransfer | ( | ) | `[inline]`

Definition at line 201 of file Shader.hpp.

References VL_DEBUG_SET_OBJECT_NAME.

## Member Function Documentation

virtual ERenderState vl::PixelTransfer::type | ( | ) | const`[inline, virtual]`

Reimplemented from vl::RenderState.

Definition at line 236 of file Shader.hpp.

References vl::RS_PixelTransfer.

void PixelTransfer::apply | ( | int | index,
|  | const Camera * | camera,
|  | OpenGLContext * | ctx
| ) |  | const`[virtual]`

The parameter cameara is NULL if we are disabling the state, non-NULL if we are enabling it.

Implements vl::RenderState.

Definition at line 181 of file Shader.cpp.

References alphaBias(), alphaScale(), blueBias(), blueScale(), depthBias(), depthScale(), greenBias(), greenScale(), indexOffset(), indexShift(), mapColor(), mapStencil(), postColorMatrixAlphaBias(), postColorMatrixAlphaScale(), postColorMatrixBlueBias(), postColorMatrixBlueScale(), postColorMatrixGreenBias(), postColorMatrixGreenScale(), postColorMatrixRedBias(), postColorMatrixRedScale(), postConvolutionAlphaBias(), postConvolutionAlphaScale(), postConvolutionBlueBias(), postConvolutionBlueScale(), postConvolutionGreenBias(), postConvolutionGreenScale(), postConvolutionRedBias(), postConvolutionRedScale(), redBias(), redScale(), and VL_CHECK_OGL.

bool vl::PixelTransfer::mapColor | ( | ) | const`[inline]`

Definition at line 240 of file Shader.hpp.

Referenced by apply().

bool vl::PixelTransfer::mapStencil | ( | ) | const`[inline]`

Definition at line 241 of file Shader.hpp.

Referenced by apply().

int vl::PixelTransfer::indexShift | ( | ) | const`[inline]`

Definition at line 242 of file Shader.hpp.

Referenced by apply().

int vl::PixelTransfer::indexOffset | ( | ) | const`[inline]`

Definition at line 243 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::redScale | ( | ) | const`[inline]`

Definition at line 244 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::greenScale | ( | ) | const`[inline]`

Definition at line 245 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::blueScale | ( | ) | const`[inline]`

Definition at line 246 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::alphaScale | ( | ) | const`[inline]`

Definition at line 247 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::depthScale | ( | ) | const`[inline]`

Definition at line 248 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::redBias | ( | ) | const`[inline]`

Definition at line 249 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::greenBias | ( | ) | const`[inline]`

Definition at line 250 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::blueBias | ( | ) | const`[inline]`

Definition at line 251 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::alphaBias | ( | ) | const`[inline]`

Definition at line 252 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::depthBias | ( | ) | const`[inline]`

Definition at line 253 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postColorMatrixRedScale | ( | ) | const`[inline]`

Definition at line 254 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postColorMatrixGreenScale | ( | ) | const`[inline]`

Definition at line 255 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postColorMatrixBlueScale | ( | ) | const`[inline]`

Definition at line 256 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postColorMatrixAlphaScale | ( | ) | const`[inline]`

Definition at line 257 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postColorMatrixRedBias | ( | ) | const`[inline]`

Definition at line 258 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postColorMatrixGreenBias | ( | ) | const`[inline]`

Definition at line 259 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postColorMatrixBlueBias | ( | ) | const`[inline]`

Definition at line 260 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postColorMatrixAlphaBias | ( | ) | const`[inline]`

Definition at line 261 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postConvolutionRedScale | ( | ) | const`[inline]`

Definition at line 262 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postConvolutionGreenScale | ( | ) | const`[inline]`

Definition at line 263 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postConvolutionBlueScale | ( | ) | const`[inline]`

Definition at line 264 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postConvolutionAlphaScale | ( | ) | const`[inline]`

Definition at line 265 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postConvolutionRedBias | ( | ) | const`[inline]`

Definition at line 266 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postConvolutionGreenBias | ( | ) | const`[inline]`

Definition at line 267 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postConvolutionBlueBias | ( | ) | const`[inline]`

Definition at line 268 of file Shader.hpp.

Referenced by apply().

float vl::PixelTransfer::postConvolutionAlphaBias | ( | ) | const`[inline]`

Definition at line 269 of file Shader.hpp.

Referenced by apply().

void vl::PixelTransfer::setMapColor | ( | bool | map_color ) | `[inline]`

Definition at line 271 of file Shader.hpp.

void vl::PixelTransfer::setMapStencil | ( | bool | map_stencil ) | `[inline]`

Definition at line 272 of file Shader.hpp.

void vl::PixelTransfer::setIndexShift | ( | int | index_shift ) | `[inline]`

Definition at line 273 of file Shader.hpp.

void vl::PixelTransfer::setIndexOffset | ( | int | index_offset ) | `[inline]`

Definition at line 274 of file Shader.hpp.

void vl::PixelTransfer::setRedScale | ( | float | red_scale ) | `[inline]`

Definition at line 275 of file Shader.hpp.

void vl::PixelTransfer::setGreenScale | ( | float | green_scale ) | `[inline]`

Definition at line 276 of file Shader.hpp.

void vl::PixelTransfer::setBlueScale | ( | float | blue_scale ) | `[inline]`

Definition at line 277 of file Shader.hpp.

void vl::PixelTransfer::setAlphaScale | ( | float | alpha_scale ) | `[inline]`

Definition at line 278 of file Shader.hpp.

void vl::PixelTransfer::setDepthScale | ( | float | depth_scale ) | `[inline]`

Definition at line 279 of file Shader.hpp.

void vl::PixelTransfer::setRedBias | ( | float | red_bias ) | `[inline]`

Definition at line 280 of file Shader.hpp.

void vl::PixelTransfer::setGreenBias | ( | float | green_bias ) | `[inline]`

Definition at line 281 of file Shader.hpp.

void vl::PixelTransfer::setBlueBias | ( | float | blue_bias ) | `[inline]`

Definition at line 282 of file Shader.hpp.

void vl::PixelTransfer::setAlphaBias | ( | float | alpha_bias ) | `[inline]`

Definition at line 283 of file Shader.hpp.

void vl::PixelTransfer::setDepthBias | ( | float | depth_bias ) | `[inline]`

Definition at line 284 of file Shader.hpp.

void vl::PixelTransfer::setPostColorMatrixRedScale | ( | float | scale ) | `[inline]`

Definition at line 285 of file Shader.hpp.

void vl::PixelTransfer::setPostColorMatrixGreenScale | ( | float | scale ) | `[inline]`

Definition at line 286 of file Shader.hpp.

void vl::PixelTransfer::setPostColorMatrixBlueScale | ( | float | scale ) | `[inline]`

Definition at line 287 of file Shader.hpp.

void vl::PixelTransfer::setPostColorMatrixAlphaScale | ( | float | scale ) | `[inline]`

Definition at line 288 of file Shader.hpp.

void vl::PixelTransfer::setPostColorMatrixRedBias | ( | float | bias ) | `[inline]`

Definition at line 289 of file Shader.hpp.

void vl::PixelTransfer::setPostColorMatrixGreenBias | ( | float | bias ) | `[inline]`

Definition at line 290 of file Shader.hpp.

void vl::PixelTransfer::setPostColorMatrixBlueBias | ( | float | bias ) | `[inline]`

Definition at line 291 of file Shader.hpp.

void vl::PixelTransfer::setPostColorMatrixAlphaBias | ( | float | bias ) | `[inline]`

Definition at line 292 of file Shader.hpp.

void vl::PixelTransfer::setPostConvolutionRedScale | ( | float | scale ) | `[inline]`

Definition at line 293 of file Shader.hpp.

void vl::PixelTransfer::setPostConvolutionGreenScale | ( | float | scale ) | `[inline]`

Definition at line 294 of file Shader.hpp.

void vl::PixelTransfer::setPostConvolutionBlueScale | ( | float | scale ) | `[inline]`

Definition at line 295 of file Shader.hpp.

void vl::PixelTransfer::setPostConvolutionAlphaScale | ( | float | scale ) | `[inline]`

Definition at line 296 of file Shader.hpp.

void vl::PixelTransfer::setPostConvolutionRedBias | ( | float | bias ) | `[inline]`

Definition at line 297 of file Shader.hpp.

void vl::PixelTransfer::setPostConvolutionGreenBias | ( | float | bias ) | `[inline]`

Definition at line 298 of file Shader.hpp.

void vl::PixelTransfer::setPostConvolutionBlueBias | ( | float | bias ) | `[inline]`

Definition at line 299 of file Shader.hpp.

void vl::PixelTransfer::setPostConvolutionAlphaBias | ( | float | bias ) | `[inline]`

Definition at line 300 of file Shader.hpp.

virtual ref<RenderState> vl::PixelTransfer::clone | ( | ) | const`[inline, virtual]`

Implements vl::RenderState.

Definition at line 302 of file Shader.hpp.

## Member Data Documentation

bool vl::PixelTransfer::mMapColor`[protected]`

Definition at line 310 of file Shader.hpp.

bool vl::PixelTransfer::mMapStencil`[protected]`

Definition at line 311 of file Shader.hpp.

int vl::PixelTransfer::mIndexShift`[protected]`

Definition at line 312 of file Shader.hpp.

int vl::PixelTransfer::mIndexOffset`[protected]`

Definition at line 313 of file Shader.hpp.

float vl::PixelTransfer::mRedScale`[protected]`

Definition at line 314 of file Shader.hpp.

float vl::PixelTransfer::mGreenScale`[protected]`

Definition at line 315 of file Shader.hpp.

float vl::PixelTransfer::mBlueScale`[protected]`

Definition at line 316 of file Shader.hpp.

float vl::PixelTransfer::mAlphaScale`[protected]`

Definition at line 317 of file Shader.hpp.

float vl::PixelTransfer::mDepthScale`[protected]`

Definition at line 318 of file Shader.hpp.

float vl::PixelTransfer::mRedBias`[protected]`

Definition at line 319 of file Shader.hpp.

float vl::PixelTransfer::mGreenBias`[protected]`

Definition at line 320 of file Shader.hpp.

float vl::PixelTransfer::mBlueBias`[protected]`

Definition at line 321 of file Shader.hpp.

float vl::PixelTransfer::mAlphaBias`[protected]`

Definition at line 322 of file Shader.hpp.

float vl::PixelTransfer::mDepthBias`[protected]`

Definition at line 323 of file Shader.hpp.

float vl::PixelTransfer::mPostColorMatrixRedScale`[protected]`

Definition at line 324 of file Shader.hpp.

float vl::PixelTransfer::mPostColorMatrixGreenScale`[protected]`

Definition at line 325 of file Shader.hpp.

float vl::PixelTransfer::mPostColorMatrixBlueScale`[protected]`

Definition at line 326 of file Shader.hpp.

float vl::PixelTransfer::mPostColorMatrixAlphaScale`[protected]`

Definition at line 327 of file Shader.hpp.

float vl::PixelTransfer::mPostColorMatrixRedBias`[protected]`

Definition at line 328 of file Shader.hpp.

float vl::PixelTransfer::mPostColorMatrixGreenBias`[protected]`

Definition at line 329 of file Shader.hpp.

float vl::PixelTransfer::mPostColorMatrixBlueBias`[protected]`

Definition at line 330 of file Shader.hpp.

float vl::PixelTransfer::mPostColorMatrixAlphaBias`[protected]`

Definition at line 331 of file Shader.hpp.

float vl::PixelTransfer::mPostConvolutionRedScale`[protected]`

Definition at line 332 of file Shader.hpp.

float vl::PixelTransfer::mPostConvolutionGreenScale`[protected]`

Definition at line 333 of file Shader.hpp.

float vl::PixelTransfer::mPostConvolutionBlueScale`[protected]`

Definition at line 334 of file Shader.hpp.

float vl::PixelTransfer::mPostConvolutionAlphaScale`[protected]`

Definition at line 335 of file Shader.hpp.

float vl::PixelTransfer::mPostConvolutionRedBias`[protected]`

Definition at line 336 of file Shader.hpp.

float vl::PixelTransfer::mPostConvolutionGreenBias`[protected]`

Definition at line 337 of file Shader.hpp.

float vl::PixelTransfer::mPostConvolutionBlueBias`[protected]`

Definition at line 338 of file Shader.hpp.

float vl::PixelTransfer::mPostConvolutionAlphaBias`[protected]`

Definition at line 339 of file Shader.hpp.

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

- D:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vlGraphics/Shader.hpp
- D:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vlGraphics/Shader.cpp

Visualization Library v2011.09.1162 Reference Documentation
Copyright 2005-2011 Michele Bosi. All rights reserved.
Updated on Thu Jan 26 2012 00:44:50.
Permission is granted to use this page to write and publish articles regarding Visualization Library.