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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_CANVAS_RENDERING_IRENDERMODULE_HXX
#define INCLUDED_CANVAS_RENDERING_IRENDERMODULE_HXX
#include <sal/types.h>
#include <boost/shared_ptr.hpp>
#include <boost/noncopyable.hpp>
namespace basegfx
{
class B2DRange;
class B2IRange;
class B2IVector;
class B2IPoint;
}
namespace canvas
{
struct ISurface;
struct Vertex
{
float r,g,b,a;
float u,v;
float x,y,z;
};
/** Output module interface for backend render implementations.
Implement this interface for each operating system- or
library-specific rendering backend, which needs coupling with
the canvas rendering framework (which can be shared between
all backend implementations).
*/
struct IRenderModule
{
/** Type of primitive passed to the render module via
pushVertex()
*/
enum PrimitiveType
{
PRIMITIVE_TYPE_UNKNOWN,
PRIMITIVE_TYPE_TRIANGLE,
PRIMITIVE_TYPE_QUAD
};
virtual ~IRenderModule() {}
/// Lock rendermodule against concurrent access
virtual void lock() const = 0;
/// Unlock rendermodule for concurrent access
virtual void unlock() const = 0;
/** Maximal size of VRAM pages available
This is typically the maximum texture size of the
hardware, or some arbitrary limit if the backend is
software.
*/
virtual ::basegfx::B2IVector getPageSize() = 0;
/** Create a (possibly hardware-accelerated) surface
@return a pointer to a surface, which is an abstraction of
a piece of (possibly hardware-accelerated) texture memory.
*/
virtual ::boost::shared_ptr<ISurface> createSurface( const ::basegfx::B2IVector& surfaceSize ) = 0;
/** Begin rendering the given primitive.
Each beginPrimitive() call must be matched with an
endPrimitive() call.
*/
virtual void beginPrimitive( PrimitiveType eType ) = 0;
/** Finish rendering a primitive.
Each beginPrimitive() call must be matched with an
endPrimitive() call.
*/
virtual void endPrimitive() = 0;
/** Add given vertex to current primitive
After issuing a beginPrimitive(), each pushVertex() adds a
vertex to the active primitive.
*/
virtual void pushVertex( const Vertex& vertex ) = 0;
/** Query error status
@returns true, if an error occurred during primitive
construction.
*/
virtual bool isError() = 0;
};
typedef ::boost::shared_ptr< IRenderModule > IRenderModuleSharedPtr;
/// Little RAII wrapper for guarding access to IRenderModule interface
class RenderModuleGuard : private ::boost::noncopyable
{
public:
explicit RenderModuleGuard( const IRenderModuleSharedPtr& rRenderModule ) :
mpRenderModule( rRenderModule )
{
mpRenderModule->lock();
}
~RenderModuleGuard()
{
mpRenderModule->unlock();
}
private:
const IRenderModuleSharedPtr mpRenderModule;
};
}
#endif // INCLUDED_CANVAS_RENDERING_IRENDERMODULE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
