# Visualization Library

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

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

Public Member Functions | Protected Attributes

# vl::Texture::SetupParams Class Reference

SetupParams wraps all the parameters needed to crate a Texture. More...

`#include <Texture.hpp>`

Inheritance diagram for vl::Texture::SetupParams:

List of all members.

## Public Member Functions

| SetupParams ()
void | setImagePath (const String &path)
const String & | imagePath () const
void | setImage (const Image *image)
const Image * | image () const
const BufferObject * | bufferObject () const
BufferObject * | bufferObject ()
void | setBufferObject (BufferObject *bo)
void | setDimension (ETextureDimension dimension)
ETextureDimension | dimension () const
void | setFormat (ETextureFormat format)
ETextureFormat | format () const
void | setBorder (bool on)
bool | border () const
void | setGenMipmaps (bool on)
bool | genMipmaps () const
void | setWidth (int w)
int | width () const
void | setHeight (int h)
int | height () const
void | setDepth (int d)
int | depth () const
int | samples () const
void | setSamples (int samples)
bool | fixedSamplesLocations () const
void | setFixedSamplesLocations (bool fixed)

## Protected Attributes

String | mImagePath
ref< BufferObject > | mBufferObject
ref< Image > | mImage
ETextureDimension | mDimension
ETextureFormat | mFormat
int | mWidth
int | mHeight
int | mDepth
int | mSamples
bool | mBorder
bool | mGenMipmaps
bool | mFixedSamplesLocation

## Detailed Description

SetupParams wraps all the parameters needed to crate a Texture.

A SetupParams object is automatically setup and bound to a Texture after calling prepareTexture2D() and similar functions. Once the SetupParams are bound to a Texture calling Texture::createTexture() will create a new Texture according to what specified in the SetupParams objects. After Texture::createTexture() the SetupParams object is kept but eventual Image and BufferObjects will be released. If an Image was used it's filePath() is assigned to SetupParam::imagePath().

Definition at line 152 of file Texture.hpp.

## Constructor & Destructor Documentation

vl::Texture::SetupParams::SetupParams | ( | ) | `[inline]`

Definition at line 155 of file Texture.hpp.

References vl::TD_TEXTURE_2D, and vl::TF_RGBA.

## Member Function Documentation

void vl::Texture::SetupParams::setImagePath | ( | const String & | path ) | `[inline]`

Definition at line 166 of file Texture.hpp.

const String& vl::Texture::SetupParams::imagePath | ( | ) | const`[inline]`

Definition at line 167 of file Texture.hpp.

Referenced by vl::VLXClassWrapper_Texture::exportTexture().

void vl::Texture::SetupParams::setImage | ( | const Image * | image ) | `[inline]`

Definition at line 169 of file Texture.hpp.

Referenced by vl::Texture::createTexture(), vl::Texture::prepareTexture1D(), vl::Texture::prepareTexture1DArray(), vl::Texture::prepareTexture2D(), vl::Texture::prepareTexture2DArray(), vl::Texture::prepareTexture3D(), vl::Texture::prepareTextureCubemap(), and vl::Texture::prepareTextureRectangle().

const Image* vl::Texture::SetupParams::image | ( | ) | const`[inline]`

Definition at line 170 of file Texture.hpp.

Referenced by vl::Texture::createTexture(), and vl::VLXClassWrapper_Texture::exportTexture().

const BufferObject* vl::Texture::SetupParams::bufferObject | ( | ) | const`[inline]`

Definition at line 172 of file Texture.hpp.

Referenced by vl::VLXClassWrapper_Texture::exportTexture().

BufferObject* vl::Texture::SetupParams::bufferObject | ( | ) | `[inline]`

Definition at line 173 of file Texture.hpp.

void vl::Texture::SetupParams::setBufferObject | ( | BufferObject * | bo ) | `[inline]`

Definition at line 174 of file Texture.hpp.

void vl::Texture::SetupParams::setDimension | ( | ETextureDimension | dimension ) | `[inline]`

Definition at line 176 of file Texture.hpp.

Referenced by vl::Texture::prepareTexture2DMultisample(), vl::Texture::prepareTexture2DMultisampleArray(), and vl::Texture::prepareTextureBuffer().

ETextureDimension vl::Texture::SetupParams::dimension | ( | ) | const`[inline]`

Definition at line 177 of file Texture.hpp.

Referenced by vl::Texture::createTexture(), and vl::VLXClassWrapper_Texture::exportTexture().

void vl::Texture::SetupParams::setFormat | ( | ETextureFormat | format ) | `[inline]`

Definition at line 179 of file Texture.hpp.

ETextureFormat vl::Texture::SetupParams::format | ( | ) | const`[inline]`

Definition at line 180 of file Texture.hpp.

Referenced by vl::Texture::createTexture(), and vl::VLXClassWrapper_Texture::exportTexture().

void vl::Texture::SetupParams::setBorder | ( | bool | on ) | `[inline]`

Definition at line 182 of file Texture.hpp.

bool vl::Texture::SetupParams::border | ( | ) | const`[inline]`

Definition at line 183 of file Texture.hpp.

Referenced by vl::Texture::createTexture().

void vl::Texture::SetupParams::setGenMipmaps | ( | bool | on ) | `[inline]`

Definition at line 185 of file Texture.hpp.

bool vl::Texture::SetupParams::genMipmaps | ( | ) | const`[inline]`

Definition at line 186 of file Texture.hpp.

Referenced by vl::Texture::createTexture(), and vl::VLXClassWrapper_Texture::exportTexture().

void vl::Texture::SetupParams::setWidth | ( | int | w ) | `[inline]`

Definition at line 188 of file Texture.hpp.

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

Definition at line 189 of file Texture.hpp.

Referenced by vl::Texture::createTexture(), and vl::VLXClassWrapper_Texture::exportTexture().

void vl::Texture::SetupParams::setHeight | ( | int | h ) | `[inline]`

Definition at line 191 of file Texture.hpp.

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

Definition at line 192 of file Texture.hpp.

Referenced by vl::Texture::createTexture(), and vl::VLXClassWrapper_Texture::exportTexture().

void vl::Texture::SetupParams::setDepth | ( | int | d ) | `[inline]`

Definition at line 194 of file Texture.hpp.

int vl::Texture::SetupParams::depth | ( | ) | const`[inline]`

Definition at line 195 of file Texture.hpp.

Referenced by vl::Texture::createTexture(), and vl::VLXClassWrapper_Texture::exportTexture().

int vl::Texture::SetupParams::samples | ( | ) | const`[inline]`

Definition at line 197 of file Texture.hpp.

Referenced by vl::VLXClassWrapper_Texture::exportTexture().

void vl::Texture::SetupParams::setSamples | ( | int | samples ) | `[inline]`

Definition at line 198 of file Texture.hpp.

bool vl::Texture::SetupParams::fixedSamplesLocations | ( | ) | const`[inline]`

Definition at line 200 of file Texture.hpp.

Referenced by vl::VLXClassWrapper_Texture::exportTexture().

void vl::Texture::SetupParams::setFixedSamplesLocations | ( | bool | fixed ) | `[inline]`

Definition at line 201 of file Texture.hpp.

## Member Data Documentation

String vl::Texture::SetupParams::mImagePath`[protected]`

Definition at line 204 of file Texture.hpp.

ref<BufferObject> vl::Texture::SetupParams::mBufferObject`[protected]`

Definition at line 205 of file Texture.hpp.

ref<Image> vl::Texture::SetupParams::mImage`[protected]`

Definition at line 206 of file Texture.hpp.

ETextureDimension vl::Texture::SetupParams::mDimension`[protected]`

Definition at line 207 of file Texture.hpp.

ETextureFormat vl::Texture::SetupParams::mFormat`[protected]`

Definition at line 208 of file Texture.hpp.

int vl::Texture::SetupParams::mWidth`[protected]`

Definition at line 209 of file Texture.hpp.

int vl::Texture::SetupParams::mHeight`[protected]`

Definition at line 209 of file Texture.hpp.

int vl::Texture::SetupParams::mDepth`[protected]`

Definition at line 209 of file Texture.hpp.

int vl::Texture::SetupParams::mSamples`[protected]`

Definition at line 210 of file Texture.hpp.

bool vl::Texture::SetupParams::mBorder`[protected]`

Definition at line 211 of file Texture.hpp.

bool vl::Texture::SetupParams::mGenMipmaps`[protected]`

Definition at line 212 of file Texture.hpp.

bool vl::Texture::SetupParams::mFixedSamplesLocation`[protected]`

Definition at line 213 of file Texture.hpp.

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

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

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