fdo-mirrors/cairo
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/cairo/cairo.git synced 2026-01-09 18:10:25 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
cairo/src/cairo-script.h

99 lines
3 KiB
C
Raw Normal View History

Add CairoScript backend. A new meta-surface backend for serialising drawing operations to a CairoScript file. The principal use (as currently envisaged) is to provide a round-trip testing mechanism for CairoScript - i.e. we can generate script files for every test in the suite and check that we can replay them with perfect fidelity. (Obviously this does not provide complete coverage of CairoScript's syntax, but should give reasonable coverage over the operators.)
2008-11-04 10:45:34 +00:00
/* cairo - a vector graphics library with display and print output
*
* Copyright © 2008 Chris Wilson
*
* This library is free software; you can redistribute it and/or
* modify it either under the terms of the GNU Lesser General Public
* License version 2.1 as published by the Free Software Foundation
* (the "LGPL") or, at your option, under the terms of the Mozilla
* Public License Version 1.1 (the "MPL"). If you do not alter this
* notice, a recipient may use your version of this file under either
* the MPL or the LGPL.
*
* You should have received a copy of the LGPL along with this library
* in the file COPYING-LGPL-2.1; if not, write to the Free Software
Update FSF address I updated the Free Software Foundation address using the following script. for i in $(git grep Temple | cut -d: -f1 ) do sed -e 's/59 Temple Place[, -]* Suite 330, Boston, MA *02111-1307[, ]* USA/51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA/' -i "$i" done Fixes http://bugs.freedesktop.org/show_bug.cgi?id=21356
2010-04-27 10:17:23 +02:00
* Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
Add CairoScript backend. A new meta-surface backend for serialising drawing operations to a CairoScript file. The principal use (as currently envisaged) is to provide a round-trip testing mechanism for CairoScript - i.e. we can generate script files for every test in the suite and check that we can replay them with perfect fidelity. (Obviously this does not provide complete coverage of CairoScript's syntax, but should give reasonable coverage over the operators.)
2008-11-04 10:45:34 +00:00
* You should have received a copy of the MPL along with this library
* in the file COPYING-MPL-1.1
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
* OF ANY KIND, either express or implied. See the LGPL or the MPL for
* the specific language governing rights and limitations.
*
* The Original Code is the cairo graphics library.
*
* The Initial Developer of the Original Code is Chris Wilson
*
* Contributor(s):
* Chris Wilson <chris@chris-wilson.co.uk>
*/
#ifndef CAIRO_SCRIPT_H
#define CAIRO_SCRIPT_H
#include "cairo.h"
#if CAIRO_HAS_SCRIPT_SURFACE
CAIRO_BEGIN_DECLS
script: Add documentation Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>
2011-12-02 16:12:02 +00:00
/**
* cairo_script_mode_t:
* @CAIRO_SCRIPT_MODE_ASCII: the output will be in readable text (default)
* @CAIRO_SCRIPT_MODE_BINARY: the output will use byte codes
*
doc: script_mode_t needs at least one line of text Gtk-doc recognizes documentation only if there is additional text. Signed-off-by: Uli Schlachter <psychon@znc.in>
2012-03-04 17:46:10 +01:00
* A set of script output variants.
*
* Since: 1.10
script: Add documentation Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>
2011-12-02 16:12:02 +00:00
**/
[script] Introduce cairo_script_context_t cairo_script_context_t is an encapsulation object for interfacing with the output - multiple surfaces can share the same context, meaning that they write to the same destination file/stream.
2009-08-13 17:21:05 +01:00
typedef enum {
script: Add documentation Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>
2011-12-02 16:12:02 +00:00
CAIRO_SCRIPT_MODE_ASCII,
CAIRO_SCRIPT_MODE_BINARY
[script] Introduce cairo_script_context_t cairo_script_context_t is an encapsulation object for interfacing with the output - multiple surfaces can share the same context, meaning that they write to the same destination file/stream.
2009-08-13 17:21:05 +01:00
} cairo_script_mode_t;
Add CairoScript backend. A new meta-surface backend for serialising drawing operations to a CairoScript file. The principal use (as currently envisaged) is to provide a round-trip testing mechanism for CairoScript - i.e. we can generate script files for every test in the suite and check that we can replay them with perfect fidelity. (Obviously this does not provide complete coverage of CairoScript's syntax, but should give reasonable coverage over the operators.)
2008-11-04 10:45:34 +00:00
script: Port cairo_script_context_t to cairo_device_t Use the unifying cairo_device_t for cairo_script_context_t and replace.
2010-01-18 22:43:24 +00:00
cairo_public cairo_device_t *
cairo_script_create (const char *filename);
[script] Introduce cairo_script_context_t cairo_script_context_t is an encapsulation object for interfacing with the output - multiple surfaces can share the same context, meaning that they write to the same destination file/stream.
2009-08-13 17:21:05 +01:00
script: Port cairo_script_context_t to cairo_device_t Use the unifying cairo_device_t for cairo_script_context_t and replace.
2010-01-18 22:43:24 +00:00
cairo_public cairo_device_t *
cairo_script_create_for_stream (cairo_write_func_t write_func,
void *closure);
Remove clip handling from generic surface layer. Handling clip as part of the surface state, as opposed to being part of the operation state, is cumbersome and a hindrance to providing true proxy surface support. For example, the clip must be copied from the surface onto the fallback image, but this was forgotten causing undue hassle in each backend. Another example is the contortion the meta surface endures to ensure the clip is correctly recorded. By contrast passing the clip along with the operation is quite simple and enables us to write generic handlers for providing surface wrappers. (And in the future, we should be able to write more esoteric wrappers, e.g. automatic 2x FSAA, trivially.) In brief, instead of the surface automatically applying the clip before calling the backend, the backend can call into a generic helper to apply clipping. For raster surfaces, clip regions are handled automatically as part of the composite interface. For vector surfaces, a clip helper is introduced to replay and callback into an intersect_clip_path() function as necessary. Whilst this is not primarily a performance related change (the change should just move the computation of the clip from the moment it is applied by the user to the moment it is required by the backend), it is important to track any potential regression: ppc: Speedups ======== image-rgba evolution-20090607-0 1026085.22 0.18% -> 672972.07 0.77%: 1.52x speedup ▌ image-rgba evolution-20090618-0 680579.98 0.12% -> 573237.66 0.16%: 1.19x speedup ▎ image-rgba swfdec-fill-rate-4xaa-0 460296.92 0.36% -> 407464.63 0.42%: 1.13x speedup ▏ image-rgba swfdec-fill-rate-2xaa-0 128431.95 0.47% -> 115051.86 0.42%: 1.12x speedup ▏ Slowdowns ========= image-rgba firefox-periodic-table-0 56837.61 0.78% -> 66055.17 3.20%: 1.09x slowdown ▏
2009-07-23 15:32:13 +01:00
cairo_public void
script: Port cairo_script_context_t to cairo_device_t Use the unifying cairo_device_t for cairo_script_context_t and replace.
2010-01-18 22:43:24 +00:00
cairo_script_write_comment (cairo_device_t *script,
const char *comment,
int len);
Remove clip handling from generic surface layer. Handling clip as part of the surface state, as opposed to being part of the operation state, is cumbersome and a hindrance to providing true proxy surface support. For example, the clip must be copied from the surface onto the fallback image, but this was forgotten causing undue hassle in each backend. Another example is the contortion the meta surface endures to ensure the clip is correctly recorded. By contrast passing the clip along with the operation is quite simple and enables us to write generic handlers for providing surface wrappers. (And in the future, we should be able to write more esoteric wrappers, e.g. automatic 2x FSAA, trivially.) In brief, instead of the surface automatically applying the clip before calling the backend, the backend can call into a generic helper to apply clipping. For raster surfaces, clip regions are handled automatically as part of the composite interface. For vector surfaces, a clip helper is introduced to replay and callback into an intersect_clip_path() function as necessary. Whilst this is not primarily a performance related change (the change should just move the computation of the clip from the moment it is applied by the user to the moment it is required by the backend), it is important to track any potential regression: ppc: Speedups ======== image-rgba evolution-20090607-0 1026085.22 0.18% -> 672972.07 0.77%: 1.52x speedup ▌ image-rgba evolution-20090618-0 680579.98 0.12% -> 573237.66 0.16%: 1.19x speedup ▎ image-rgba swfdec-fill-rate-4xaa-0 460296.92 0.36% -> 407464.63 0.42%: 1.13x speedup ▏ image-rgba swfdec-fill-rate-2xaa-0 128431.95 0.47% -> 115051.86 0.42%: 1.12x speedup ▏ Slowdowns ========= image-rgba firefox-periodic-table-0 56837.61 0.78% -> 66055.17 3.20%: 1.09x slowdown ▏
2009-07-23 15:32:13 +01:00
Add CairoScript backend. A new meta-surface backend for serialising drawing operations to a CairoScript file. The principal use (as currently envisaged) is to provide a round-trip testing mechanism for CairoScript - i.e. we can generate script files for every test in the suite and check that we can replay them with perfect fidelity. (Obviously this does not provide complete coverage of CairoScript's syntax, but should give reasonable coverage over the operators.)
2008-11-04 10:45:34 +00:00
cairo_public void
script: Port cairo_script_context_t to cairo_device_t Use the unifying cairo_device_t for cairo_script_context_t and replace.
2010-01-18 22:43:24 +00:00
cairo_script_set_mode (cairo_device_t *script,
cairo_script_mode_t mode);
Add CairoScript backend. A new meta-surface backend for serialising drawing operations to a CairoScript file. The principal use (as currently envisaged) is to provide a round-trip testing mechanism for CairoScript - i.e. we can generate script files for every test in the suite and check that we can replay them with perfect fidelity. (Obviously this does not provide complete coverage of CairoScript's syntax, but should give reasonable coverage over the operators.)
2008-11-04 10:45:34 +00:00
cairo_public cairo_script_mode_t
script: Port cairo_script_context_t to cairo_device_t Use the unifying cairo_device_t for cairo_script_context_t and replace.
2010-01-18 22:43:24 +00:00
cairo_script_get_mode (cairo_device_t *script);
[script] Introduce cairo_script_context_t cairo_script_context_t is an encapsulation object for interfacing with the output - multiple surfaces can share the same context, meaning that they write to the same destination file/stream.
2009-08-13 17:21:05 +01:00
cairo_public cairo_surface_t *
script: Port cairo_script_context_t to cairo_device_t Use the unifying cairo_device_t for cairo_script_context_t and replace.
2010-01-18 22:43:24 +00:00
cairo_script_surface_create (cairo_device_t *script,
[script] Emit surface content Include the desired content with the creation info.
2009-08-13 21:59:12 +01:00
cairo_content_t content,
[script] Introduce cairo_script_context_t cairo_script_context_t is an encapsulation object for interfacing with the output - multiple surfaces can share the same context, meaning that they write to the same destination file/stream.
2009-08-13 17:21:05 +01:00
double width,
double height);
cairo_public cairo_surface_t *
script: Port cairo_script_context_t to cairo_device_t Use the unifying cairo_device_t for cairo_script_context_t and replace.
2010-01-18 22:43:24 +00:00
cairo_script_surface_create_for_target (cairo_device_t *script,
[script] Introduce cairo_script_context_t cairo_script_context_t is an encapsulation object for interfacing with the output - multiple surfaces can share the same context, meaning that they write to the same destination file/stream.
2009-08-13 17:21:05 +01:00
cairo_surface_t *target);
Add CairoScript backend. A new meta-surface backend for serialising drawing operations to a CairoScript file. The principal use (as currently envisaged) is to provide a round-trip testing mechanism for CairoScript - i.e. we can generate script files for every test in the suite and check that we can replay them with perfect fidelity. (Obviously this does not provide complete coverage of CairoScript's syntax, but should give reasonable coverage over the operators.)
2008-11-04 10:45:34 +00:00
Add 'flight-data-recorder' utility. This is a simple variation on cairo-trace that wraps records the last 16 contexts by wrapping the target surface inside a tee surface, along with a meta/recording surface. Then on receipt of a SIGUSR1, those last 16 contexts are played via a script-surface into /tmp/fdr.trace. Mostly proof-of-concept, it seems to be causing a number of rendering glitches whilst testing with firefox -- otherwise, it seems to works.
2009-08-16 21:08:22 +01:00
cairo_public cairo_status_t
script: Port cairo_script_context_t to cairo_device_t Use the unifying cairo_device_t for cairo_script_context_t and replace.
2010-01-18 22:43:24 +00:00
cairo_script_from_recording_surface (cairo_device_t *script,
cairo_surface_t *recording_surface);
Add 'flight-data-recorder' utility. This is a simple variation on cairo-trace that wraps records the last 16 contexts by wrapping the target surface inside a tee surface, along with a meta/recording surface. Then on receipt of a SIGUSR1, those last 16 contexts are played via a script-surface into /tmp/fdr.trace. Mostly proof-of-concept, it seems to be causing a number of rendering glitches whilst testing with firefox -- otherwise, it seems to works.
2009-08-16 21:08:22 +01:00
Add CairoScript backend. A new meta-surface backend for serialising drawing operations to a CairoScript file. The principal use (as currently envisaged) is to provide a round-trip testing mechanism for CairoScript - i.e. we can generate script files for every test in the suite and check that we can replay them with perfect fidelity. (Obviously this does not provide complete coverage of CairoScript's syntax, but should give reasonable coverage over the operators.)
2008-11-04 10:45:34 +00:00
CAIRO_END_DECLS
#else /*CAIRO_HAS_SCRIPT_SURFACE*/
# error Cairo was not compiled with support for the CairoScript backend
#endif /*CAIRO_HAS_SCRIPT_SURFACE*/
#endif /*CAIRO_SCRIPT_H*/
Reference in a new issue Copy permalink