# Visualization Library

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

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

Public Member Functions | Protected Attributes

# vl::CopyTexSubImage2D Class Reference

Wraps glCopyTexSubImage2D, see also CopyTexSubImage. To be used also for 1D array textures. More...

`#include <CopyTexSubImage.hpp>`

Inheritance diagram for vl::CopyTexSubImage2D:

List of all members.

## Public Member Functions

| CopyTexSubImage2D (int level, int xoffset, int yoffset, int x, int y, int width, int height, Texture *texture=NULL, ETex2DTarget target=T2DT_TEXTURE_2D, EReadDrawBuffer read_buffer=RDB_BACK_LEFT)
virtual const char * | className ()
| Returns the name of the class.
void | setTexture (Texture *tex)
void | setLevel (int level)
void | setXOffset (int xoffset)
void | setYOffset (int yoffset)
void | setX (int x)
void | setY (int y)
void | setWidth (int width)
void | setHeight (int height)
void | setTarget (ETex2DTarget target)
Texture * | texture ()
const Texture * | texture () const
int | level () const
int | xoffset () const
int | yoffset () const
int | x () const
int | y () const
int | width () const
int | height () const
ETex2DTarget | target () const
virtual void | copyPixels ()
| Copies the pixels from the specified read buffer to the specified texture.

## Protected Attributes

ref< Texture > | mTexture
int | mLevel
int | mXOffset
int | mYOffset
int | mX
int | mY
int | mWidth
int | mHeight
ETex2DTarget | mTarget

## Detailed Description

Wraps glCopyTexSubImage2D, see also CopyTexSubImage. To be used also for 1D array textures.

Definition at line 172 of file CopyTexSubImage.hpp.

## Constructor & Destructor Documentation

vl::CopyTexSubImage2D::CopyTexSubImage2D | ( | int | level,
|  | int | xoffset,
|  | int | yoffset,
|  | int | x,
|  | int | y,
|  | int | width,
|  | int | height,
|  | Texture * | texture = `NULL`,
|  | ETex2DTarget | target = `T2DT_TEXTURE_2D`,
|  | EReadDrawBuffer | read_buffer = `RDB_BACK_LEFT`
| ) |  | `[inline]`

Definition at line 176 of file CopyTexSubImage.hpp.

References height(), level(), mHeight, mLevel, mTarget, mTexture, mWidth, mX, mXOffset, mY, mYOffset, vl::CopyTexSubImage::setReadBuffer(), target(), texture(), VL_DEBUG_SET_OBJECT_NAME, width(), x(), xoffset(), y(), and yoffset().

## Member Function Documentation

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

Returns the name of the class.

Reimplemented from vl::CopyTexSubImage.

Definition at line 191 of file CopyTexSubImage.hpp.

void vl::CopyTexSubImage2D::setTexture | ( | Texture * | tex ) | `[inline]`

Definition at line 193 of file CopyTexSubImage.hpp.

References mTexture.

void vl::CopyTexSubImage2D::setLevel | ( | int | level ) | `[inline]`

Definition at line 194 of file CopyTexSubImage.hpp.

References level(), and mLevel.

void vl::CopyTexSubImage2D::setXOffset | ( | int | xoffset ) | `[inline]`

Definition at line 195 of file CopyTexSubImage.hpp.

References mXOffset, and xoffset().

void vl::CopyTexSubImage2D::setYOffset | ( | int | yoffset ) | `[inline]`

Definition at line 196 of file CopyTexSubImage.hpp.

References mYOffset, and yoffset().

void vl::CopyTexSubImage2D::setX | ( | int | x ) | `[inline]`

Definition at line 197 of file CopyTexSubImage.hpp.

References mX, and x().

void vl::CopyTexSubImage2D::setY | ( | int | y ) | `[inline]`

Definition at line 198 of file CopyTexSubImage.hpp.

References mY, and y().

void vl::CopyTexSubImage2D::setWidth | ( | int | width ) | `[inline]`

Definition at line 199 of file CopyTexSubImage.hpp.

References mWidth, and width().

void vl::CopyTexSubImage2D::setHeight | ( | int | height ) | `[inline]`

Definition at line 200 of file CopyTexSubImage.hpp.

References height(), and mHeight.

void vl::CopyTexSubImage2D::setTarget | ( | ETex2DTarget | target ) | `[inline]`

Definition at line 201 of file CopyTexSubImage.hpp.

References mTarget, and target().

Texture* vl::CopyTexSubImage2D::texture | ( | ) | `[inline]`

Definition at line 203 of file CopyTexSubImage.hpp.

References vl::ref< T >::get(), and mTexture.

Referenced by copyPixels(), and CopyTexSubImage2D().

const Texture* vl::CopyTexSubImage2D::texture | ( | ) | const`[inline]`

Definition at line 204 of file CopyTexSubImage.hpp.

References vl::ref< T >::get(), and mTexture.

int vl::CopyTexSubImage2D::level | ( | ) | const`[inline]`

Definition at line 205 of file CopyTexSubImage.hpp.

References mLevel.

Referenced by copyPixels(), CopyTexSubImage2D(), and setLevel().

int vl::CopyTexSubImage2D::xoffset | ( | ) | const`[inline]`

Definition at line 206 of file CopyTexSubImage.hpp.

References mXOffset.

Referenced by copyPixels(), CopyTexSubImage2D(), and setXOffset().

int vl::CopyTexSubImage2D::yoffset | ( | ) | const`[inline]`

Definition at line 207 of file CopyTexSubImage.hpp.

References mYOffset.

Referenced by copyPixels(), CopyTexSubImage2D(), and setYOffset().

int vl::CopyTexSubImage2D::x | ( | ) | const`[inline]`

Definition at line 208 of file CopyTexSubImage.hpp.

References mX.

Referenced by copyPixels(), CopyTexSubImage2D(), and setX().

int vl::CopyTexSubImage2D::y | ( | ) | const`[inline]`

Definition at line 209 of file CopyTexSubImage.hpp.

References mY.

Referenced by copyPixels(), CopyTexSubImage2D(), and setY().

int vl::CopyTexSubImage2D::width | ( | ) | const`[inline]`

Definition at line 210 of file CopyTexSubImage.hpp.

References mWidth.

Referenced by copyPixels(), CopyTexSubImage2D(), and setWidth().

int vl::CopyTexSubImage2D::height | ( | ) | const`[inline]`

Definition at line 211 of file CopyTexSubImage.hpp.

References mHeight.

Referenced by copyPixels(), CopyTexSubImage2D(), and setHeight().

ETex2DTarget vl::CopyTexSubImage2D::target | ( | ) | const`[inline]`

Definition at line 212 of file CopyTexSubImage.hpp.

References mTarget.

Referenced by copyPixels(), CopyTexSubImage2D(), and setTarget().

virtual void vl::CopyTexSubImage2D::copyPixels | ( | ) | `[inline, virtual]`

Copies the pixels from the specified read buffer to the specified texture.

Implements vl::CopyTexSubImage.

Definition at line 214 of file CopyTexSubImage.hpp.

References height(), level(), vl::CopyTexSubImage::readBuffer(), vl::T2DT_TEXTURE_CUBE_MAP_NEGATIVE_X, vl::T2DT_TEXTURE_CUBE_MAP_NEGATIVE_Y, vl::T2DT_TEXTURE_CUBE_MAP_NEGATIVE_Z, vl::T2DT_TEXTURE_CUBE_MAP_POSITIVE_X, vl::T2DT_TEXTURE_CUBE_MAP_POSITIVE_Y, vl::T2DT_TEXTURE_CUBE_MAP_POSITIVE_Z, target(), texture(), VL_CHECK, VL_CHECK_OGL, width(), x(), xoffset(), y(), and yoffset().

## Member Data Documentation

ref<Texture> vl::CopyTexSubImage2D::mTexture`[protected]`

Definition at line 258 of file CopyTexSubImage.hpp.

Referenced by CopyTexSubImage2D(), setTexture(), and texture().

int vl::CopyTexSubImage2D::mLevel`[protected]`

Definition at line 259 of file CopyTexSubImage.hpp.

Referenced by CopyTexSubImage2D(), level(), and setLevel().

int vl::CopyTexSubImage2D::mXOffset`[protected]`

Definition at line 260 of file CopyTexSubImage.hpp.

Referenced by CopyTexSubImage2D(), setXOffset(), and xoffset().

int vl::CopyTexSubImage2D::mYOffset`[protected]`

Definition at line 261 of file CopyTexSubImage.hpp.

Referenced by CopyTexSubImage2D(), setYOffset(), and yoffset().

int vl::CopyTexSubImage2D::mX`[protected]`

Definition at line 262 of file CopyTexSubImage.hpp.

Referenced by CopyTexSubImage2D(), setX(), and x().

int vl::CopyTexSubImage2D::mY`[protected]`

Definition at line 263 of file CopyTexSubImage.hpp.

Referenced by CopyTexSubImage2D(), setY(), and y().

int vl::CopyTexSubImage2D::mWidth`[protected]`

Definition at line 264 of file CopyTexSubImage.hpp.

Referenced by CopyTexSubImage2D(), setWidth(), and width().

int vl::CopyTexSubImage2D::mHeight`[protected]`

Definition at line 265 of file CopyTexSubImage.hpp.

Referenced by CopyTexSubImage2D(), height(), and setHeight().

ETex2DTarget vl::CopyTexSubImage2D::mTarget`[protected]`

Definition at line 266 of file CopyTexSubImage.hpp.

Referenced by CopyTexSubImage2D(), setTarget(), and target().

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

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

Visualization Library v2011.05.1142 Reference Documentation
Copyright 2005-2011 Michele Bosi. All rights reserved.
Updated on Thu May 26 2011 22:51:37.
Permission is granted to use this page to write and publish articles regarding Visualization Library.