oglplus::Example Class Reference

Base class for OGLplus examples. More...

#include </home/chochlik/devel/oglplus/example/oglplus/example.hpp>

Inherited by oglplus::BarGridExample, oglplus::BilliardExample, oglplus::BlenderMeshExample, oglplus::BlenderMeshExample, oglplus::BlobExample, oglplus::CloudExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeExample, oglplus::CubeMapExample, oglplus::CubeMapExample, oglplus::CubeMapExample, oglplus::DOFExample, oglplus::FBTexExample, oglplus::FBTexExample, oglplus::FBTexExample, oglplus::FBTexExample, oglplus::FlareExample, oglplus::FlowExample, oglplus::FogExample, oglplus::FurExample, oglplus::GlassAndMetalExample, oglplus::GlassExample, oglplus::HaloExample, oglplus::JellyExample, oglplus::LandscapeExample, oglplus::LightRayExample, oglplus::LiquidExample, oglplus::LiquidExample, oglplus::MeshExample, oglplus::MetaballExample, oglplus::MorphingExample, oglplus::MotionBlurExample, oglplus::MultiViewportExample, oglplus::NeonExample, oglplus::ObjectTrackingExample, oglplus::ObjMeshExample, oglplus::OctreeExample, oglplus::ParallaxExample, oglplus::ParallaxMapExample, oglplus::ParticlesExample, oglplus::ParticlesExample, oglplus::PickingExample, oglplus::PoolTilesExample, oglplus::RainExample, oglplus::RaytraceExample, oglplus::RectangleExample, oglplus::RectangleExample, oglplus::RectangleExample, oglplus::RectangleExample, oglplus::RectangleExample, oglplus::RectangleExample, oglplus::RectangleExample, oglplus::RectangleExample, oglplus::RectangleExample, oglplus::RectangleExample, oglplus::ReflectionExample, oglplus::ReflectionExample, oglplus::ReflectionExample, oglplus::ShadowExample, oglplus::ShadowMapExample, oglplus::ShapeExample, oglplus::SinglePassEdgeExample, oglplus::SketchExample, oglplus::SkyBoxExample, oglplus::SkyBoxExample, oglplus::SmokeExample, oglplus::SmokeExample, oglplus::SortingExample, oglplus::SphereExample, oglplus::SphereExample, oglplus::SphereExample, oglplus::SubsurfExample, oglplus::SubsurfExample, oglplus::SurfaceExample, oglplus::SurfaceExample, oglplus::TessellationExample, oglplus::TessellationExample, oglplus::TessellationExample, oglplus::TessellationExample, oglplus::TorusExample, oglplus::TorusExample, oglplus::TorusExample, oglplus::TorusExample, oglplus::TorusExample, oglplus::TorusExample, oglplus::TorusExample, oglplus::TransitionExample, oglplus::TriangleExample, oglplus::TriangleExample, oglplus::TriangleExample, oglplus::TriangleExample, oglplus::VaseExample, oglplus::VolLightExample, oglplus::VolumeExample, oglplus::VoronoiExample, oglplus::WavesExample, and oglplus::WritingExample.

Public Member Functions
virtual void	PrepareThread (unsigned, ExampleThread &)
	Place to do additional thread-related initialization of example. More...
virtual bool	Continue (double duration)
	Hint for the main function whether to continue rendering. More...
virtual bool	Continue (const ExampleClock &clock)
	Hint for the main function whether to continue rendering. More...
virtual void	Reshape (GLuint width, GLuint height)=0
	Reshape event handler.
virtual void	MouseMoveNormalized (float x, float y, float aspect)
	Mouse move event handler.
virtual void	MouseMove (GLuint x, GLuint y, GLuint width, GLuint height)
	Mouse move event handler.
virtual void	Render (double)
	Rendering procedure with simple timing.
virtual void	Render (ExampleClock &clock)
	Rendering procedure with advanced timing.
virtual double	RenderPart (unsigned, ExampleClock &clock)
	Rendering procedure split into several parts.
virtual double	ScreenshotTime (void) const
	The time of the default screenshot.
virtual double	FrameTime (void) const
	Single frame time in the screenshot capture sequence.
virtual GLuint	HeatUpFrames (void) const
	The number of heat-up sequence frames.
virtual double	HeatUpTime (void) const
	The screenshot capture heat-up sequence start time.

Detailed Description

Base class for OGLplus examples.

Examples:

standalone/001_triangle_glut_gles3.cpp, standalone/001_triangle_glut_glew.cpp, standalone/001_triangle_sdl_glew.cpp, standalone/001_triangle_wxgl_glew.cpp, and standalone/002_triangle_compatibility.cpp.

Member Function Documentation

virtual bool oglplus::Example::Continue ( double  duration )

virtual

Hint for the main function whether to continue rendering.

Implementations of the main function may choose to ignore the result of this function or not call it at all. This is the overload for simple timing.

Referenced by Continue().

virtual bool oglplus::Example::Continue ( const ExampleClock &  clock )

virtual

Hint for the main function whether to continue rendering.

Implementations of the main function may choose to ignore the result of this function or not call it at all. This is the overload for advanced timing.

References Continue(), oglplus::ExampleClock::Now(), and oglplus::ExampleTimePeriod::Seconds().

virtual void oglplus::Example::PrepareThread ( unsigned  , ExampleThread &    )

virtual

Place to do additional thread-related initialization of example.

This function is called in the context of the main thread after all example threads are created, before the rendering loop starts.

---

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

• /home/chochlik/devel/oglplus/example/oglplus/example.hpp