# 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 const char * | className ()
| Returns the name of the class.
virtual ERenderState | type () const
virtual void | apply (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)

## 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 57 of file Shader.hpp.

## Constructor & Destructor Documentation

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

Definition at line 60 of file Shader.hpp.

References VL_DEBUG_SET_OBJECT_NAME.

## Member Function Documentation

virtual const char* vl::PixelTransfer::className | ( | ) | `[inline, virtual]`

Returns the name of the class.

Reimplemented from vl::RenderState.

Definition at line 95 of file Shader.hpp.

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

Reimplemented from vl::RenderState.

Definition at line 97 of file Shader.hpp.

References vl::RS_PixelTransfer.

void PixelTransfer::apply | ( | 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 169 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 101 of file Shader.hpp.

Referenced by apply().

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

Definition at line 102 of file Shader.hpp.

Referenced by apply().

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

Definition at line 103 of file Shader.hpp.

Referenced by apply().

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

Definition at line 104 of file Shader.hpp.

Referenced by apply().

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

Definition at line 105 of file Shader.hpp.

Referenced by apply().

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

Definition at line 106 of file Shader.hpp.

Referenced by apply().

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

Definition at line 107 of file Shader.hpp.

Referenced by apply().

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

Definition at line 108 of file Shader.hpp.

Referenced by apply().

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

Definition at line 109 of file Shader.hpp.

Referenced by apply().

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

Definition at line 110 of file Shader.hpp.

Referenced by apply().

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

Definition at line 111 of file Shader.hpp.

Referenced by apply().

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

Definition at line 112 of file Shader.hpp.

Referenced by apply().

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

Definition at line 113 of file Shader.hpp.

Referenced by apply().

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

Definition at line 114 of file Shader.hpp.

Referenced by apply().

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

Definition at line 115 of file Shader.hpp.

Referenced by apply().

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

Definition at line 116 of file Shader.hpp.

Referenced by apply().

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

Definition at line 117 of file Shader.hpp.

Referenced by apply().

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

Definition at line 118 of file Shader.hpp.

Referenced by apply().

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

Definition at line 119 of file Shader.hpp.

Referenced by apply().

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

Definition at line 120 of file Shader.hpp.

Referenced by apply().

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

Definition at line 121 of file Shader.hpp.

Referenced by apply().

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

Definition at line 122 of file Shader.hpp.

Referenced by apply().

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

Definition at line 123 of file Shader.hpp.

Referenced by apply().

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

Definition at line 124 of file Shader.hpp.

Referenced by apply().

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

Definition at line 125 of file Shader.hpp.

Referenced by apply().

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

Definition at line 126 of file Shader.hpp.

Referenced by apply().

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

Definition at line 127 of file Shader.hpp.

Referenced by apply().

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

Definition at line 128 of file Shader.hpp.

Referenced by apply().

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

Definition at line 129 of file Shader.hpp.

Referenced by apply().

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

Definition at line 130 of file Shader.hpp.

Referenced by apply().

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

Definition at line 132 of file Shader.hpp.

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

Definition at line 133 of file Shader.hpp.

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

Definition at line 134 of file Shader.hpp.

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

Definition at line 135 of file Shader.hpp.

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

Definition at line 136 of file Shader.hpp.

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

Definition at line 137 of file Shader.hpp.

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

Definition at line 138 of file Shader.hpp.

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

Definition at line 139 of file Shader.hpp.

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

Definition at line 140 of file Shader.hpp.

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

Definition at line 141 of file Shader.hpp.

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

Definition at line 142 of file Shader.hpp.

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

Definition at line 143 of file Shader.hpp.

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

Definition at line 144 of file Shader.hpp.

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

Definition at line 145 of file Shader.hpp.

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

Definition at line 146 of file Shader.hpp.

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

Definition at line 147 of file Shader.hpp.

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

Definition at line 148 of file Shader.hpp.

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

Definition at line 149 of file Shader.hpp.

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

Definition at line 150 of file Shader.hpp.

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

Definition at line 151 of file Shader.hpp.

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

Definition at line 152 of file Shader.hpp.

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

Definition at line 153 of file Shader.hpp.

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

Definition at line 154 of file Shader.hpp.

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

Definition at line 155 of file Shader.hpp.

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

Definition at line 156 of file Shader.hpp.

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

Definition at line 157 of file Shader.hpp.

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

Definition at line 158 of file Shader.hpp.

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

Definition at line 159 of file Shader.hpp.

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

Definition at line 160 of file Shader.hpp.

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

Definition at line 161 of file Shader.hpp.

## Member Data Documentation

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

Definition at line 164 of file Shader.hpp.

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

Definition at line 165 of file Shader.hpp.

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

Definition at line 166 of file Shader.hpp.

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

Definition at line 167 of file Shader.hpp.

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

Definition at line 168 of file Shader.hpp.

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

Definition at line 169 of file Shader.hpp.

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

Definition at line 170 of file Shader.hpp.

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

Definition at line 171 of file Shader.hpp.

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

Definition at line 172 of file Shader.hpp.

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

Definition at line 173 of file Shader.hpp.

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

Definition at line 174 of file Shader.hpp.

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

Definition at line 175 of file Shader.hpp.

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

Definition at line 176 of file Shader.hpp.

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

Definition at line 177 of file Shader.hpp.

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

Definition at line 178 of file Shader.hpp.

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

Definition at line 179 of file Shader.hpp.

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

Definition at line 180 of file Shader.hpp.

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

Definition at line 181 of file Shader.hpp.

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

Definition at line 182 of file Shader.hpp.

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

Definition at line 183 of file Shader.hpp.

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

Definition at line 184 of file Shader.hpp.

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

Definition at line 185 of file Shader.hpp.

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

Definition at line 186 of file Shader.hpp.

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

Definition at line 187 of file Shader.hpp.

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

Definition at line 188 of file Shader.hpp.

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

Definition at line 189 of file Shader.hpp.

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

Definition at line 190 of file Shader.hpp.

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

Definition at line 191 of file Shader.hpp.

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

Definition at line 192 of file Shader.hpp.

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

Definition at line 193 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.05.1142 Reference Documentation
Copyright 2005-2011 Michele Bosi. All rights reserved.
Updated on Thu May 26 2011 22:51:45.
Permission is granted to use this page to write and publish articles regarding Visualization Library.