Celartem::ImageUtils::CacheParam Struct Reference

#include <pxl_imageparam.h>

Inheritance diagram for Celartem::ImageUtils::CacheParam:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 CacheParam (bool inClearCache=true)

Public Attributes

bool requireCacheClear


Detailed Description

This structure is used to instruct the cache instance to clear all cached images. The following code illustrates how to use this class:
                void clearCache(Image *inImage)
                {
                    inImage->setParam(&CacheParam());
                }
See also:
ImageCache, Image Parameter Structures, ImageParam

Definition at line 84 of file pxl_imageparam.h.


Constructor & Destructor Documentation

Celartem::ImageUtils::CacheParam::CacheParam ( bool  inClearCache = true  )  [inline]

This constructor initializes the CacheParam structure.

Parameters:
inClearCache This parameter instructs the ImageCache to clear the cached image (true) or not (false).

Definition at line 96 of file pxl_imageparam.h.


Member Data Documentation

bool Celartem::ImageUtils::CacheParam::requireCacheClear

Whether to clear the cache (true) or not (false). By default, this is initialized as true.

Definition at line 88 of file pxl_imageparam.h.


The documentation for this struct was generated from the following file:
This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:34 2008.