/usr/include/ClanLib-1.0/ClanLib/Display/graphic_context.h is in libclanlib-dev 1.0~svn3827-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 | /*
** ClanLib SDK
** Copyright (c) 1997-2005 The ClanLib Team
**
** This software is provided 'as-is', without any express or implied
** warranty. In no event will the authors be held liable for any damages
** arising from the use of this software.
**
** Permission is granted to anyone to use this software for any purpose,
** including commercial applications, and to alter it and redistribute it
** freely, subject to the following restrictions:
**
** 1. The origin of this software must not be misrepresented; you must not
** claim that you wrote the original software. If you use this software
** in a product, an acknowledgment in the product documentation would be
** appreciated but is not required.
** 2. Altered source versions must be plainly marked as such, and must not be
** misrepresented as being the original software.
** 3. This notice may not be removed or altered from any source distribution.
**
** Note: Some of the libraries ClanLib may link to may have additional
** requirements or restrictions.
**
** File Author(s):
**
** Magnus Norddahl
** (if your name is missing here, please add it)
*/
//! clanDisplay="Display 2D"
//! header=display.h
#ifndef header_graphic_context
#define header_graphic_context
#ifdef CL_API_DLL
#ifdef CL_DISPLAY_EXPORT
#define CL_API_DISPLAY __declspec(dllexport)
#else
#define CL_API_DISPLAY __declspec(dllimport)
#endif
#else
#define CL_API_DISPLAY
#endif
#if _MSC_VER > 1000
#pragma once
#endif
#ifdef _MSC_VER
#pragma warning( disable : 4786)
#endif
#include "../signals.h"
#include <stack>
#include "color.h"
#include "gradient.h"
#include "stencil_func.h"
#include "pixel_buffer.h"
#include "../Core/Math/point.h"
#include "../Core/Math/rect.h"
#include "../Core/Math/quad.h"
#include "../Core/Math/matrix4x4.h"
class CL_GraphicContext_Generic;
class CL_Surface;
//: Graphic rendering target.
//- !group=Display/Display 2D!
//- !header=display.h!
//- <p>A graphic context is something that ClanLib can render onto.</p>
class CL_API_DISPLAY CL_GraphicContext
{
//! Construction:
public:
//: Constructs a graphic context.
CL_GraphicContext();
CL_GraphicContext(const CL_GraphicContext ©);
virtual ~CL_GraphicContext();
//! Attributes:
public:
//: Returns the current width of the context.
int get_width() const;
//: Returns the current height of the context.
int get_height() const;
//: Returns the current clipping rectangle used on the graphic context.
const CL_Rect &get_cliprect() const;
//: Returns the current effective modelview matrix.
const CL_Matrix4x4 &get_modelview() const;
//: Returns a pixel value at specified coordinates.
CL_Color get_pixel(int x, int y) const;
//: Return the content of buffer 'i' copyied into a CL_PixelBuffer
CL_PixelBuffer get_pixeldata(const CL_Rect& rect = CL_Rect(0,0,0,0), int i = 0) const;
//: Returns the maximum size of a surface this graphic context supports.
//- <p>It returns CL_Size(0,0) if there is no limitation to the max
//- surface size. Of course it is still limited by available memory,
//- which is not considered by this function.</p>
CL_Size get_max_surface_size() const;
//! Operations:
public:
//: Copy assignment operator.
CL_GraphicContext &operator =(const CL_GraphicContext ©);
//: Flushes current rendering batch. <i>Deprecated</i>
//- <p>With the OpenGL target, this causes the graphic context to end its current
//- active glBegin()/glEnd() pair, making it possible to call other OpenGL calls.</p>
//- <p><i>This function is deprecated</i></p>.
void flush();
//: Draw a pixel at (x, y) using the specified color.
void draw_pixel(int x, int y, const CL_Color &color);
//: Draw a line from (x1, y1) to (x2, y2) using the specified color.
void draw_line(float x1, float y1, float x2, float y2, const CL_Color &color);
//: Draw a continuous chain of lines in the specified color.
void draw_lines(int count, double *vertices, const CL_Color &color);
//: Draw a rectangle using the specified color.
void draw_rect(const CL_Rectf &rect, const CL_Color &color);
//: Draw a gradient rectangle using the specified gradient.
void fill_rect(const CL_Rectf &rect, const CL_Gradient &gradient);
//: Draw a filled rectangle using the specified color.
void fill_rect(const CL_Rectf &rect, const CL_Color &color);
//: Draw a quad using the specified color.
void draw_quad(const CL_Quad &quad, const CL_Color &color);
//: Draw a gradient quad using the specified gradient.
void fill_quad(const CL_Quad &quad, const CL_Gradient &gradient);
//: Draw a filled quad using the specified color.
void fill_quad(const CL_Quad &quad, const CL_Color &color);
//: Draw a triangle using the specified color.
//param double x : x coordinates of triangle vertices
//param double y : y coordinates of triangle vertices
//param CL_Color &Color : color to use
void draw_triangle(
double x1, double y1,
double x2, double y2,
double x3, double y3,
const CL_Color &color);
//: Draw a gradient filled triangle.
//param double x : x coordinates of triangle vertices
//param double y : y coordinates of triangle vertices
//param CL_Gradient &gradient : color gradient to use
void fill_triangle(
double x1, double y1,
double x2, double y2,
double x3, double y3,
const CL_Gradient &gradient);
//: Draw triangles with color array (optionally textured).
//- <p>uchar color array, range: 0-255
//- integer (pixel) texture coordinates</p>
//param unsigned int count : number of triangles to draw
//param bool fill : draw filled/outline
//param double *vertices : pointer to array of triangle vertices (x y z x y z x...)
//param unsigned char *color : pointer to array of triangle vertice colors (r b g a r g b a r...)
//param int *uv : (optional) pointer to array of triangle vertice texture coordinates (u v u v u...)
//param CL_Surface *texture : (optional) texture to use
void draw_triangles(
unsigned int count,
bool fill,
double *vertices,
unsigned char *color,
int *uv=0,
CL_Surface *texture=0);
//: Draw triangles with single color (optionally textured).
//- <p>single color
//- integer (pixel) texture coordinates</p>
//param unsigned int count : number of triangles to draw
//param bool fill : draw filled/outline
//param double *vertices : pointer to array of triangle vertices (x y z x y z x...)
//param CL_Color &color : triangle color
//param int *uv : (optional) pointer to array of triangle vertice texture coordinates (u v u v u...)
//param CL_Surface *texture : (optional) texture to use
void draw_triangles(
unsigned int count,
bool fill,
double *vertices,
const CL_Color &color,
int *uv=0,
CL_Surface *texture=0);
//: Draw triangle array with color array (optionally textured).
//- <p> double color array, range: 0-1
//- double (0-1) texture coordinates</p>
//param unsigned int count : number of triangles to draw
//param bool fill : draw filled/outline
//param double *vertices : pointer to array of triangle vertices (x y z x y z x...)
//param double *color : pointer to array of triangle vertice colors (r b g a r g b a r...)
//param int *uv : (optional) pointer to array of triangle vertice texture coordinates (u v u v u...)
//param CL_Surface *texture : (optional) texture to use
void draw_trianglesd(
unsigned int count,
bool fill,
double *vertices,
const CL_Color &color,
double *uv=0,
CL_Surface *texture=0);
//: Draw triangles with single color (optionally textured).
//- <p>single color
//- double (0-1) texture coordinates</p>
//param unsigned int count : number of triangles to draw
//param bool fill : draw filled/outline
//param double *vertices : pointer to array of triangle vertices (x y z x y z x...)
//param CL_Color &color : triangle color
//param double *uv : (optional) pointer to array of triangle vertice texture coordinates (u v u v u...)
//param CL_Surface *texture : (optional) texture to use
void draw_trianglesd(
unsigned int count,
bool fill,
double *vertices,
double *color,
double *uv=0,
CL_Surface *texture=0);
//: Clears the whole context using the specified color.
void clear(const CL_Color &color = CL_Color(0,0,0));
//: Set the current clipping rectangle.
void set_cliprect(const CL_Rect &rect);
//: Push current clipping rectangle to stack.
//- <p>If a rectangle is passed, it afterwards sets clipping
//- rectangle to the union of the current rectangle and the passed
//- rectangle.</p>
void push_cliprect(const CL_Rect &rect);
void push_cliprect();
//: Pop current clipping rectangle from the stack.
void pop_cliprect();
//: Sets the model view matrix to a new matrix.
void set_modelview(const CL_Matrix4x4 &matrix);
//: Multiplies the passed matrix onto the model view matrix.
void add_modelview(const CL_Matrix4x4 &matrix);
//: Pushes current model view matrix onto the model view stack.
void push_modelview();
//: Sets a translate offset matrix, ignoring any earlier model view settings.
//- <p> This offset will affect any subsequent display operations on the current
//- displaycard, by translating the position of the display operation with the offset.</p>
void set_translate(double x, double y, double z = 0.0);
//: Adds the translate offset.
//- <p> This offset will affect any subsequent display operations on the current
//- displaycard, by translating the position of the display operation with the offset.
//- The offset will be offset by any previous offsets pushed onto the stack,
//- eg. it inherits the previous offset. </p>
void add_translate(double x, double y, double z = 0.0);
//: Push translation offset onto model view stack.
//- <p>This function is a convenience function for calling push_modelview, then add_translate.</p>
//- <p> This offset will affect any subsequent display operations on the current
//- displaycard, by translating the position of the display operation with the offset.
//- The offset will be offset by any previous offsets pushed onto the stack,
//- eg. it inherits the previous offset. </p>
void push_translate(double x, double y, double z = 0.0);
//: Sets a rotation matrix, ignoring any earlier model view settings.
void set_rotate(double angle, double x = 0.0, double y = 0.0, double z = 1.0);
//: Adds a rotation matrix to existing model view.
void add_rotate(double angle, double x = 0.0, double y = 0.0, double z = 1.0);
//: Pushes a rotation matrix onto model view stack.
void push_rotate(double angle, double x = 0.0, double y = 0.0, double z = 1.0);
//: Sets a scale matrix, ignoring any earlier model view settings.
void set_scale(double x, double y, double z = 1.0);
//: Adds a scale matrix to existing model view.
void add_scale(double x, double y, double z = 1.0);
//: Pushes a scale matrix onto model view stack.
void push_scale(double x, double y, double z = 1.0);
//: Pops last pushed model view matrix off the stack and makes it the active one.
void pop_modelview();
//: Clear the stencil buffer
//param int value : value to clear to. Default: 0
void clear_stencil(int value=0);
//: Set stencil test function when writing to stencil, and operations to do when a test passes or fails
//param CL_StencilOp pass : Modification to stencil buffer when a test passes.
//param CL_StencilOp fail : Modification to stencil buffer when a test fails.
//param CL_StencilFunc func : Type of test to do when writing to stencil.
//param int ref : value compared to stencil contents. Default: 1
void set_stencil_operation(CL_StencilOp pass, CL_StencilOp fail, CL_StencilFunc func, int ref=1);
//: Enables writing to the stencil buffer
//param bool enabled : Enables/disables stencil testing.
//param bool visible : Enables/disables color buffer writing if stencil writing is enabled. Default: true.
//param float alpha_limit : Only pixels with alpha >= alpha limit are drawn to the stencil buffer. Default: 0.1f
void enable_stencil_write(bool enabled, bool visible=true, float alpha_limit=0.1f);
//: Enables stencil buffer testing
//- <p> Individual pixels are tested against the values in the stencil buffer, and
//- drawn depending on the comparison result. This can be used for masking and
//- boolean operations on bitmaps </p>
//param bool enabled : Enables/disables stencil testing.
//param int func : Type of comparison. Default: lequal (pass if ref <= stencil)
//param int ref : Reference value that the stencil is compared with. Default: 1
void enable_stencil_test(bool enabled, CL_StencilFunc func=stencil_lequal, int ref=1);
//! Implementation:
public:
CL_GraphicContext(CL_GraphicContext_Generic *impl);
CL_GraphicContext_Generic *impl;
};
#endif
|