/* -*- Mode: c; tab-width: 8; c-basic-offset: 4; indent-tabs-mode: t; -*- */
/* cairo - a vector graphics library with display and print output
*
* Copyright © 2002 University of Southern California
* Copyright © 2005 Red Hat, Inc.
*
* 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
* Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
* 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 University of Southern
* California.
*
* Contributor(s):
* Carl D. Worth <cworth@cworth.org>
*/
#ifndef CAIRO_SURFACE_BACKEND_PRIVATE_H
#define CAIRO_SURFACE_BACKEND_PRIVATE_H
#include "cairo-compiler-private.h"
#include "cairo-error-private.h"
#include "cairo-pattern-private.h"
CAIRO_BEGIN_DECLS
struct _cairo_surface_backend {
cairo_surface_type_t type;
cairo_warn cairo_status_t
(*finish) (
void *surface);
cairo_t *
(*create_context) (
void *surface);
cairo_surface_t *
(*create_similar) (
void *surface,
cairo_content_t content,
int width,
int height);
cairo_surface_t *
(*create_similar_image) (
void *surface,
cairo_format_t format,
int width,
int height);
cairo_image_surface_t *
(*map_to_image) (
void *surface,
const cairo_rectangle_int_t *extents);
cairo_int_status_t
(*unmap_image) (
void *surface,
cairo_image_surface_t *image);
cairo_surface_t *
(*source) (
void *abstract_surface,
cairo_rectangle_int_t *extents);
cairo_warn cairo_status_t
(*acquire_source_image) (
void *abstract_surface,
cairo_image_surface_t **image_out,
void **image_extra);
cairo_warn
void
(*release_source_image) (
void *abstract_surface,
cairo_image_surface_t *image_out,
void *image_extra);
cairo_surface_t *
(*snapshot) (
void *surface);
cairo_warn cairo_int_status_t
(*copy_page) (
void *surface);
cairo_warn cairo_int_status_t
(*show_page) (
void *surface);
/* Get the extents of the current surface. For many surface types
* this will be as simple as { x=0, y=0, width=surface->width,
* height=surface->height}.
*
* If this function is not implemented, or if it returns
* FALSE the surface is considered to be
* boundless and infinite bounds are used for it.
*/
cairo_bool_t
(*get_extents) (
void *surface,
cairo_rectangle_int_t *extents);
void
(*get_font_options) (
void *surface,
cairo_font_options_t *options);
cairo_warn cairo_status_t
(*flush) (
void *surface,
unsigned flags);
cairo_warn cairo_status_t
(*mark_dirty_rectangle) (
void *surface,
int x,
int y,
int width,
int height);
cairo_warn cairo_int_status_t
(*paint) (
void *surface,
cairo_operator_t op,
const cairo_pattern_t *source,
const cairo_clip_t *clip);
cairo_warn cairo_int_status_t
(*mask) (
void *surface,
cairo_operator_t op,
const cairo_pattern_t *source,
const cairo_pattern_t *mask,
const cairo_clip_t *clip);
cairo_warn cairo_int_status_t
(*stroke) (
void *surface,
cairo_operator_t op,
const cairo_pattern_t *source,
const cairo_path_fixed_t *path,
const cairo_stroke_style_t *style,
const cairo_matrix_t *ctm,
const cairo_matrix_t *ctm_inverse,
double tolerance,
cairo_antialias_t antialias,
const cairo_clip_t *clip);
cairo_warn cairo_int_status_t
(*fill) (
void *surface,
cairo_operator_t op,
const cairo_pattern_t *source,
const cairo_path_fixed_t *path,
cairo_fill_rule_t fill_rule,
double tolerance,
cairo_antialias_t antialias,
const cairo_clip_t *clip);
cairo_warn cairo_int_status_t
(*fill_stroke) (
void *surface,
cairo_operator_t fill_op,
const cairo_pattern_t *fill_source,
cairo_fill_rule_t fill_rule,
double fill_tolerance,
cairo_antialias_t fill_antialias,
const cairo_path_fixed_t*path,
cairo_operator_t stroke_op,
const cairo_pattern_t *stroke_source,
const cairo_stroke_style_t *stroke_style,
const cairo_matrix_t *stroke_ctm,
const cairo_matrix_t *stroke_ctm_inverse,
double stroke_tolerance,
cairo_antialias_t stroke_antialias,
const cairo_clip_t *clip);
cairo_warn cairo_int_status_t
(*show_glyphs) (
void *surface,
cairo_operator_t op,
const cairo_pattern_t *source,
cairo_glyph_t *glyphs,
int num_glyphs,
cairo_scaled_font_t *scaled_font,
const cairo_clip_t *clip);
cairo_bool_t
(*has_show_text_glyphs) (
void *surface);
cairo_warn cairo_int_status_t
(*show_text_glyphs) (
void *surface,
cairo_operator_t op,
const cairo_pattern_t *source,
const char *utf8,
int utf8_len,
cairo_glyph_t *glyphs,
int num_glyphs,
const cairo_text_cluster_t *clusters,
int num_clusters,
cairo_text_cluster_flags_t cluster_flags,
cairo_scaled_font_t *scaled_font,
const cairo_clip_t *clip);
const char **
(*get_supported_mime_types) (
void *surface);
cairo_warn cairo_int_status_t
(*tag) (
void *surface,
cairo_bool_t begin,
const char *tag_name,
const char *attributes);
cairo_bool_t
(*supports_color_glyph) (
void *surface,
cairo_scaled_font_t *scaled_font,
unsigned long glyph_index);
/* Paginated surfaces only. During the analysis stage, if any
* recording surfaces used as a source are to be replayed, this
* function will be called at the begining and end of the replay.
*
* @recording_surface - the recording surface used as a source
* @source_type - a type indicating the combination of drawing
* operation and source type
* @begin - TRUE when called before the replay, FALSE when called
* after the replay has finished.
*/
cairo_warn cairo_int_status_t
(*analyze_recording_surface)(
void *surface,
const cairo_surface_pattern_t *recording_surface_pattern,
unsigned int region_id,
cairo_analysis_source_t source_type,
cairo_bool_t begin);
cairo_warn cairo_int_status_t
(*command_id) (
void *surface,
unsigned int recording_id,
unsigned int command_id);
};
cairo_private cairo_status_t
_cairo_surface_default_acquire_source_image (
void *surface,
cairo_image_surface_t **image_out,
void **image_extra);
cairo_private
void
_cairo_surface_default_release_source_image (
void *surface,
cairo_image_surface_t *image,
void *image_extra);
cairo_private cairo_surface_t *
_cairo_surface_default_source (
void *surface,
cairo_rectangle_int_t *extents);
CAIRO_END_DECLS
#endif /* CAIRO_SURFACE_BACKEND_PRIVATE_H */
