cairo-dock-opengl.h File Reference

Data Structures
struct	_CairoDockGLConfig
	This strucure summarizes the available OpenGL configuration on the system. More...

Macros
#define	gldi_gl_container_begin_draw(pContainer)

Functions
gboolean	gldi_gl_backend_init (gboolean bForceOpenGL)
gboolean	gldi_gl_container_make_current (GldiContainer *pContainer)
gboolean	gldi_gl_container_begin_draw_full (GldiContainer *pContainer, GdkRectangle *pArea, gboolean bClear)
void	gldi_gl_container_end_draw (GldiContainer *pContainer)
void	gldi_gl_container_set_perspective_view (GldiContainer *pContainer)
void	gldi_gl_container_set_perspective_view_for_icon (Icon *pIcon)
void	gldi_gl_container_set_ortho_view (GldiContainer *pContainer)
void	gldi_gl_container_set_ortho_view_for_icon (Icon *pIcon)
void	gldi_gl_container_init (GldiContainer *pContainer)

Detailed Description

This class manages the OpenGL backend and context.

Macro Definition Documentation

#define gldi_gl_container_begin_draw

(

pContainer

)

Start drawing on a Container's OpenGL context (draw on the whole Container and clear buffers).

Parameters

pContainer

the container

Function Documentation

gboolean gldi_gl_backend_init

(

gboolean

bForceOpenGL

)

Initialize the OpenGL backend, by trying to get a suitable GLX configuration.

Parameters

bForceOpenGL

whether to force the use of OpenGL, or let the function decide.

Returns

TRUE if OpenGL is usable.

gboolean gldi_gl_container_make_current

(

GldiContainer *

pContainer

)

Make a Container's OpenGL context the current one.

Parameters

pContainer

the container

Returns

TRUE if the Container's context is now the current one.

gboolean gldi_gl_container_begin_draw_full	(	GldiContainer *	pContainer,
		GdkRectangle *	pArea,
		gboolean	bClear
	)

Start drawing on a Container's OpenGL context.

Parameters

pContainer	the container
pArea	optional area to clip the drawing (NULL to draw on the whole Container)
bClear	whether to clear the color buffer or not

void gldi_gl_container_end_draw

(

GldiContainer *

pContainer

)

Ends the drawing on a Container's OpenGL context.

Parameters

pContainer

the container

void gldi_gl_container_set_perspective_view

(

GldiContainer *

pContainer

)

Set a perspective view to the current GL context to fit a given Container. You may want to ensure the Container's context is really the current one.

Parameters

pContainer

the container

void gldi_gl_container_set_perspective_view_for_icon

(

Icon *

pIcon

)

Set a perspective view to the current GL context to fit a given Icon (which must be inside a Container). You may want to ensure the Icon's Container's context is really the current one.

Parameters

pIcon

the icon

void gldi_gl_container_set_ortho_view

(

GldiContainer *

pContainer

)

Set a orthogonal view to the current GL context to fit a given Container. You may want to ensure the Container's context is really the current one.

Parameters

pContainer

the container

void gldi_gl_container_set_ortho_view_for_icon

(

Icon *

pIcon

)

Set a orthogonal view to the current GL context to fit a given Icon (which must be inside a Container). You may want to ensure the Icon's Container's context is really the current one.

Parameters

pIcon

the icon

void gldi_gl_container_init

(

GldiContainer *

pContainer

)

Set a shared default-initialized GL context on a window.

Parameters

pContainer

the container, not yet realized.