Visualization Library 2.0.0-b3

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

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | List of all members
vl::PolygonOffset Class Reference

RenderState wrapping the OpenGL function glPolygonOffset(), see also http://www.opengl.org/sdk/docs/man/xhtml/glPolygonOffset.xml for more information. More...

#include <Shader.hpp>

+ Inheritance diagram for vl::PolygonOffset:

Public Member Functions

 PolygonOffset ()
 
virtual ERenderState type () const
 
 PolygonOffset (float factor, float units)
 
virtual void apply (int index, const Camera *, OpenGLContext *ctx) const
 The parameter cameara is NULL if we are disabling the state, non-NULL if we are enabling it. More...
 
void set (float factor, float units)
 
void setFactor (float factor)
 
void setUnits (float units)
 
float factor () const
 
float units () const
 
virtual ref< RenderStateclone () const
 
- Public Member Functions inherited from vl::RenderStateNonIndexed
 RenderStateNonIndexed ()
 
- Public Member Functions inherited from vl::RenderState
 RenderState ()
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Attributes

float mFactor
 
float mUnits
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

RenderState wrapping the OpenGL function glPolygonOffset(), see also http://www.opengl.org/sdk/docs/man/xhtml/glPolygonOffset.xml for more information.

See also
Shader, Effect, Actor, vl::EN_POLYGON_OFFSET_FILL, vl::EN_POLYGON_OFFSET_LINE, vl::EN_POLYGON_OFFSET_POINT

Definition at line 963 of file Shader.hpp.

Constructor & Destructor Documentation

◆ PolygonOffset() [1/2]

vl::PolygonOffset::PolygonOffset ( )
inline

Definition at line 968 of file Shader.hpp.

◆ PolygonOffset() [2/2]

vl::PolygonOffset::PolygonOffset ( float  factor,
float  units 
)
inline

Definition at line 975 of file Shader.hpp.

Member Function Documentation

◆ apply()

void PolygonOffset::apply ( int  index,
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 553 of file Shader.cpp.

References VL_CHECK_OGL.

◆ clone()

virtual ref<RenderState> vl::PolygonOffset::clone ( ) const
inlinevirtual

Implements vl::RenderState.

Definition at line 989 of file Shader.hpp.

◆ factor()

float vl::PolygonOffset::factor ( ) const
inline

Definition at line 985 of file Shader.hpp.

◆ set()

void vl::PolygonOffset::set ( float  factor,
float  units 
)
inline

Definition at line 979 of file Shader.hpp.

Referenced by vl::OcclusionCullRenderer::OcclusionCullRenderer().

◆ setFactor()

void vl::PolygonOffset::setFactor ( float  factor)
inline

Definition at line 981 of file Shader.hpp.

◆ setUnits()

void vl::PolygonOffset::setUnits ( float  units)
inline

Definition at line 983 of file Shader.hpp.

◆ type()

virtual ERenderState vl::PolygonOffset::type ( ) const
inlinevirtual

Reimplemented from vl::RenderState.

Definition at line 973 of file Shader.hpp.

References vl::RS_PolygonOffset.

◆ units()

float vl::PolygonOffset::units ( ) const
inline

Definition at line 987 of file Shader.hpp.

Member Data Documentation

◆ mFactor

float vl::PolygonOffset::mFactor
protected

Definition at line 997 of file Shader.hpp.

◆ mUnits

float vl::PolygonOffset::mUnits
protected

Definition at line 998 of file Shader.hpp.


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