h o m e d o c u m e n t a t i o n c l a s s h i e r a r c h y

StrokeTextureShader Class Reference

#include <BasicStrokeShaders.h>

Inheritance diagram for StrokeTextureShader:

StrokeShader List of all members.

Detailed Description

[ Texture Shader ]. Assigns a texture and a blending mode to the stroke in order to simulate its marks system.


Public Member Functions

 StrokeTextureShader (const string textureFile, Stroke::MediumType mediumType=Stroke::OPAQUE_MEDIUM, bool iTips=false)
virtual void shade (Stroke &stroke) const

Constructor & Destructor Documentation

StrokeTextureShader (  const string  textureFile,
Stroke::MediumType  mediumType = Stroke::OPAQUE_MEDIUM,
bool  iTips = false
)  [inline]
 

Builds the shader from the texture file name and the blending mode to use.

Parameters:
textureFile The the texture file name.
Attention:
The textures must be placed in the $FREESTYLE_DIR/data/textures/brushes directory.
Parameters:
mediumType The medium type and therefore, the blending mode that must be used for the rendering of this stroke.
iTips Tells whether the texture includes tips or not. If it is the case, the texture image must respect the following format: 
     *     __________
     *    |          |
     *    |    A     |
     *    |__________|
     *    |     |    |
     *    |  B  | C  |
     *    |_____|____|
     * 
     *
  • A : The stroke's corpus texture
  • B : The stroke's left extremity texture
  • C : The stroke's right extremity texture

Member Function Documentation

virtual void shade (  Stroke &  stroke  )  const [virtual]
 

The shading method

Reimplemented from StrokeShader.

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