KiCad PCB EDA Suite
KIGFX::CAIRO_COMPOSITOR Class Reference

#include <cairo_compositor.h>

Inheritance diagram for KIGFX::CAIRO_COMPOSITOR:
KIGFX::COMPOSITOR

Classes

struct  CAIRO_BUFFER
 

Public Member Functions

 CAIRO_COMPOSITOR (cairo_t **aMainContext)
 
virtual ~CAIRO_COMPOSITOR ()
 
virtual void Initialize () override
 Function Reset() performs primary initialiation, necessary to use the object. More...
 
virtual void Resize (unsigned int aWidth, unsigned int aHeight) override
 Function Resize() clears the state of COMPOSITOR, so it has to be reinitialized again with the new dimensions. More...
 
virtual unsigned int CreateBuffer () override
 Function CreateBuffer() prepares a new buffer that may be used as a rendering target. More...
 
virtual unsigned int GetBuffer () const override
 Function GetBuffer() returns currently used buffer handle. More...
 
virtual void SetBuffer (unsigned int aBufferHandle) override
 Function SetBuffer() sets the selected buffer as the rendering target. More...
 
virtual void Begin () override
 Function Begin() Call this at the beginning of each frame. More...
 
virtual void ClearBuffer (const COLOR4D &aColor) override
 Function ClearBuffer() clears the selected buffer (set by the SetBuffer() function). More...
 
virtual void DrawBuffer (unsigned int aBufferHandle) override
 Function DrawBuffer() draws the selected buffer to the output buffer. More...
 
virtual void Present () override
 Function Present() Call this to present the output buffer to the screen. More...
 
void SetAntialiasingMode (CAIRO_ANTIALIASING_MODE aMode)
 
CAIRO_ANTIALIASING_MODE GetAntialiasingMode () const
 
virtual void SetMainContext (cairo_t *aMainContext)
 Function SetMainContext() Sets a context to be treated as the main context (ie. More...
 

Protected Types

typedef uint32_t * BitmapPtr
 
typedef std::deque< CAIRO_BUFFERCAIRO_BUFFERS
 

Protected Member Functions

void clean ()
 Function clean() performs freeing of resources. More...
 
unsigned int usedBuffers ()
 Returns number of currently used buffers. More...
 

Protected Attributes

unsigned int m_current
 Currently used buffer handle. More...
 
cairo_t ** m_currentContext
 Pointer to the current context, so it can be changed. More...
 
cairo_t * m_mainContext
 Rendering target used for compositing (the main display) More...
 
cairo_matrix_t m_matrix
 Transformation matrix. More...
 
CAIRO_BUFFERS m_buffers
 Stores information about initialized buffers. More...
 
unsigned int m_stride
 Stride to use given the desired format and width. More...
 
unsigned int m_bufferSize
 Amount of memory needed to store a buffer. More...
 
cairo_antialias_t m_currentAntialiasingMode
 
unsigned int m_width
 Width of the buffer (in pixels) More...
 
unsigned int m_height
 Height of the buffer (in pixels) More...
 

Detailed Description

Definition at line 44 of file cairo_compositor.h.

Member Typedef Documentation

◆ BitmapPtr

typedef uint32_t* KIGFX::CAIRO_COMPOSITOR::BitmapPtr
protected

Definition at line 112 of file cairo_compositor.h.

◆ CAIRO_BUFFERS

Definition at line 121 of file cairo_compositor.h.

Constructor & Destructor Documentation

◆ CAIRO_COMPOSITOR()

CAIRO_COMPOSITOR::CAIRO_COMPOSITOR ( cairo_t **  aMainContext)

Definition at line 37 of file cairo_compositor.cpp.

37  :
38  m_current( 0 ), m_currentContext( aMainContext ), m_mainContext( *aMainContext ),
39  m_currentAntialiasingMode( CAIRO_ANTIALIAS_DEFAULT )
40 {
41  // Do not have uninitialized members:
42  cairo_matrix_init_identity( &m_matrix );
43  m_stride = 0;
44  m_bufferSize = 0;
45 }
unsigned int m_stride
Stride to use given the desired format and width.
unsigned int m_current
Currently used buffer handle.
cairo_antialias_t m_currentAntialiasingMode
cairo_t ** m_currentContext
Pointer to the current context, so it can be changed.
unsigned int m_bufferSize
Amount of memory needed to store a buffer.
cairo_matrix_t m_matrix
Transformation matrix.
cairo_t * m_mainContext
Rendering target used for compositing (the main display)

References m_bufferSize, m_matrix, and m_stride.

◆ ~CAIRO_COMPOSITOR()

CAIRO_COMPOSITOR::~CAIRO_COMPOSITOR ( )
virtual

Definition at line 48 of file cairo_compositor.cpp.

49 {
50  clean();
51 }
void clean()
Function clean() performs freeing of resources.

References clean().

Member Function Documentation

◆ Begin()

void CAIRO_COMPOSITOR::Begin ( )
overridevirtual

Function Begin() Call this at the beginning of each frame.

Implements KIGFX::COMPOSITOR.

Definition at line 139 of file cairo_compositor.cpp.

140 {
141 }

◆ clean()

void CAIRO_COMPOSITOR::clean ( )
protected

Function clean() performs freeing of resources.

Definition at line 171 of file cairo_compositor.cpp.

172 {
173  CAIRO_BUFFERS::const_iterator it;
174 
175  for( it = m_buffers.begin(); it != m_buffers.end(); ++it )
176  {
177  cairo_destroy( it->context );
178  cairo_surface_destroy( it->surface );
179  delete[] it->bitmap;
180  }
181 
182  m_buffers.clear();
183 }
CAIRO_BUFFERS m_buffers
Stores information about initialized buffers.

References m_buffers.

Referenced by Resize(), SetAntialiasingMode(), and ~CAIRO_COMPOSITOR().

◆ ClearBuffer()

void CAIRO_COMPOSITOR::ClearBuffer ( const COLOR4D aColor)
overridevirtual

Function ClearBuffer() clears the selected buffer (set by the SetBuffer() function).

Implements KIGFX::COMPOSITOR.

Definition at line 143 of file cairo_compositor.cpp.

144 {
145  // Clear the pixel storage
146  memset( m_buffers[m_current].bitmap, 0x00, m_bufferSize * sizeof(int) );
147 }
unsigned int m_current
Currently used buffer handle.
CAIRO_BUFFERS m_buffers
Stores information about initialized buffers.
unsigned int m_bufferSize
Amount of memory needed to store a buffer.

References m_buffers, m_bufferSize, and m_current.

◆ CreateBuffer()

unsigned int CAIRO_COMPOSITOR::CreateBuffer ( )
overridevirtual

Function CreateBuffer() prepares a new buffer that may be used as a rendering target.

Returns
is the handle of the buffer. In case of failure 0 (zero) is returned as the handle.

Implements KIGFX::COMPOSITOR.

Definition at line 94 of file cairo_compositor.cpp.

95 {
96  // Pixel storage
97  BitmapPtr bitmap = new uint32_t[m_bufferSize]();
98 
99  // Create the Cairo surface
100  cairo_surface_t* surface = cairo_image_surface_create_for_data(
101  (unsigned char*) bitmap,
102  CAIRO_FORMAT_ARGB32, m_width,
103  m_height, m_stride );
104  cairo_t* context = cairo_create( surface );
105 #ifdef __WXDEBUG__
106  cairo_status_t status = cairo_status( context );
107  wxASSERT_MSG( status == CAIRO_STATUS_SUCCESS, wxT( "Cairo context creation error" ) );
108 #endif /* __WXDEBUG__ */
109 
110  // Set default settings for the buffer
111  cairo_set_antialias( context, m_currentAntialiasingMode );
112 
113  // Use the same transformation matrix as the main context
114  cairo_get_matrix( m_mainContext, &m_matrix );
115  cairo_set_matrix( context, &m_matrix );
116 
117  // Store the new buffer
118  CAIRO_BUFFER buffer = { context, surface, bitmap };
119  m_buffers.push_back( buffer );
120 
121  return usedBuffers();
122 }
unsigned int m_stride
Stride to use given the desired format and width.
unsigned int m_width
Width of the buffer (in pixels)
Definition: compositor.h:119
unsigned int usedBuffers()
Returns number of currently used buffers.
CAIRO_BUFFERS m_buffers
Stores information about initialized buffers.
cairo_antialias_t m_currentAntialiasingMode
unsigned int m_bufferSize
Amount of memory needed to store a buffer.
cairo_matrix_t m_matrix
Transformation matrix.
cairo_t * m_mainContext
Rendering target used for compositing (the main display)
unsigned int m_height
Height of the buffer (in pixels)
Definition: compositor.h:120

References m_buffers, m_bufferSize, m_currentAntialiasingMode, KIGFX::COMPOSITOR::m_height, m_mainContext, m_matrix, m_stride, KIGFX::COMPOSITOR::m_width, and usedBuffers().

◆ DrawBuffer()

void CAIRO_COMPOSITOR::DrawBuffer ( unsigned int  aBufferHandle)
overridevirtual

Function DrawBuffer() draws the selected buffer to the output buffer.

Parameters
aBufferHandleis the handle of the buffer to be drawn.

Implements KIGFX::COMPOSITOR.

Definition at line 150 of file cairo_compositor.cpp.

151 {
152  wxASSERT_MSG( aBufferHandle <= usedBuffers(), wxT( "Tried to use a not existing buffer" ) );
153 
154  // Reset the transformation matrix, so it is possible to composite images using
155  // screen coordinates instead of world coordinates
156  cairo_get_matrix( m_mainContext, &m_matrix );
157  cairo_identity_matrix( m_mainContext );
158 
159  // Draw the selected buffer contents
160  cairo_set_source_surface( m_mainContext, m_buffers[aBufferHandle - 1].surface, 0.0, 0.0 );
161  cairo_paint( m_mainContext );
162 
163  // Restore the transformation matrix
164  cairo_set_matrix( m_mainContext, &m_matrix );
165 }
unsigned int usedBuffers()
Returns number of currently used buffers.
CAIRO_BUFFERS m_buffers
Stores information about initialized buffers.
cairo_matrix_t m_matrix
Transformation matrix.
cairo_t * m_mainContext
Rendering target used for compositing (the main display)

References m_buffers, m_mainContext, m_matrix, and usedBuffers().

◆ GetAntialiasingMode()

CAIRO_ANTIALIASING_MODE KIGFX::CAIRO_COMPOSITOR::GetAntialiasingMode ( ) const
inline

Definition at line 81 of file cairo_compositor.h.

82  {
84  {
85  case CAIRO_ANTIALIAS_FAST:
87  case CAIRO_ANTIALIAS_GOOD:
89  case CAIRO_ANTIALIAS_BEST:
91  default:
93  }
94  }
cairo_antialias_t m_currentAntialiasingMode

References KIGFX::BEST, KIGFX::FAST, KIGFX::GOOD, m_currentAntialiasingMode, and KIGFX::NONE.

◆ GetBuffer()

virtual unsigned int KIGFX::CAIRO_COMPOSITOR::GetBuffer ( ) const
inlineoverridevirtual

Function GetBuffer() returns currently used buffer handle.

Returns
Currently used buffer handle.

Implements KIGFX::COMPOSITOR.

Definition at line 60 of file cairo_compositor.h.

61  {
62  return m_current + 1;
63  }
unsigned int m_current
Currently used buffer handle.

References m_current.

◆ Initialize()

void CAIRO_COMPOSITOR::Initialize ( )
overridevirtual

Function Reset() performs primary initialiation, necessary to use the object.

Implements KIGFX::COMPOSITOR.

Definition at line 54 of file cairo_compositor.cpp.

55 {
56  // Nothing has to be done
57 }

◆ Present()

void CAIRO_COMPOSITOR::Present ( )
overridevirtual

Function Present() Call this to present the output buffer to the screen.

Implements KIGFX::COMPOSITOR.

Definition at line 167 of file cairo_compositor.cpp.

168 {
169 }

◆ Resize()

void CAIRO_COMPOSITOR::Resize ( unsigned int  aWidth,
unsigned int  aHeight 
)
overridevirtual

Function Resize() clears the state of COMPOSITOR, so it has to be reinitialized again with the new dimensions.

Parameters
aWidthis the framebuffer width (in pixels).
aHeightis the framebuffer height (in pixels).

Implements KIGFX::COMPOSITOR.

Definition at line 82 of file cairo_compositor.cpp.

83 {
84  clean();
85 
86  m_width = aWidth;
87  m_height = aHeight;
88 
89  m_stride = cairo_format_stride_for_width( CAIRO_FORMAT_ARGB32, m_width );
91 }
void clean()
Function clean() performs freeing of resources.
unsigned int m_stride
Stride to use given the desired format and width.
unsigned int m_width
Width of the buffer (in pixels)
Definition: compositor.h:119
unsigned int m_bufferSize
Amount of memory needed to store a buffer.
unsigned int m_height
Height of the buffer (in pixels)
Definition: compositor.h:120

References clean(), m_bufferSize, KIGFX::COMPOSITOR::m_height, m_stride, and KIGFX::COMPOSITOR::m_width.

◆ SetAntialiasingMode()

void CAIRO_COMPOSITOR::SetAntialiasingMode ( CAIRO_ANTIALIASING_MODE  aMode)

Definition at line 60 of file cairo_compositor.cpp.

61 {
62 
63  switch( aMode )
64  {
66  m_currentAntialiasingMode = CAIRO_ANTIALIAS_FAST;
67  break;
69  m_currentAntialiasingMode = CAIRO_ANTIALIAS_GOOD;
70  break;
72  m_currentAntialiasingMode = CAIRO_ANTIALIAS_BEST;
73  break;
74  default:
75  m_currentAntialiasingMode = CAIRO_ANTIALIAS_NONE;
76  }
77 
78  clean();
79 }
void clean()
Function clean() performs freeing of resources.
cairo_antialias_t m_currentAntialiasingMode

References KIGFX::BEST, clean(), KIGFX::FAST, KIGFX::GOOD, and m_currentAntialiasingMode.

◆ SetBuffer()

void CAIRO_COMPOSITOR::SetBuffer ( unsigned int  aBufferHandle)
overridevirtual

Function SetBuffer() sets the selected buffer as the rendering target.

All the following drawing functions are going to be rendered in the selected buffer.

Parameters
aBufferHandleis the handle of the buffer or 0 in case of rendering directly to the display.

Implements KIGFX::COMPOSITOR.

Definition at line 125 of file cairo_compositor.cpp.

126 {
127  wxASSERT_MSG( aBufferHandle <= usedBuffers(), wxT( "Tried to use a not existing buffer" ) );
128 
129  // Get currently used transformation matrix, so it can be applied to the new buffer
130  cairo_get_matrix( *m_currentContext, &m_matrix );
131 
132  m_current = aBufferHandle - 1;
134 
135  // Apply the current transformation matrix
136  cairo_set_matrix( *m_currentContext, &m_matrix );
137 }
unsigned int usedBuffers()
Returns number of currently used buffers.
unsigned int m_current
Currently used buffer handle.
CAIRO_BUFFERS m_buffers
Stores information about initialized buffers.
cairo_t ** m_currentContext
Pointer to the current context, so it can be changed.
cairo_matrix_t m_matrix
Transformation matrix.

References m_buffers, m_current, m_currentContext, m_matrix, and usedBuffers().

◆ SetMainContext()

virtual void KIGFX::CAIRO_COMPOSITOR::SetMainContext ( cairo_t *  aMainContext)
inlinevirtual

Function SetMainContext() Sets a context to be treated as the main context (ie.

as a target of buffers rendering and as a source of settings for newly created buffers).

Parameters
aMainContextis the context that should be treated as the main one.

Definition at line 103 of file cairo_compositor.h.

104  {
105  m_mainContext = aMainContext;
106 
107  // Use the context's transformation matrix
108  cairo_get_matrix( m_mainContext, &m_matrix );
109  }
cairo_matrix_t m_matrix
Transformation matrix.
cairo_t * m_mainContext
Rendering target used for compositing (the main display)

References m_mainContext, and m_matrix.

◆ usedBuffers()

unsigned int KIGFX::CAIRO_COMPOSITOR::usedBuffers ( )
inlineprotected

Returns number of currently used buffers.

Definition at line 147 of file cairo_compositor.h.

148  {
149  return m_buffers.size();
150  }
CAIRO_BUFFERS m_buffers
Stores information about initialized buffers.

References m_buffers.

Referenced by CreateBuffer(), DrawBuffer(), and SetBuffer().

Member Data Documentation

◆ m_buffers

CAIRO_BUFFERS KIGFX::CAIRO_COMPOSITOR::m_buffers
protected

Stores information about initialized buffers.

Definition at line 133 of file cairo_compositor.h.

Referenced by clean(), ClearBuffer(), CreateBuffer(), DrawBuffer(), SetBuffer(), and usedBuffers().

◆ m_bufferSize

unsigned int KIGFX::CAIRO_COMPOSITOR::m_bufferSize
protected

Amount of memory needed to store a buffer.

Definition at line 136 of file cairo_compositor.h.

Referenced by CAIRO_COMPOSITOR(), ClearBuffer(), CreateBuffer(), and Resize().

◆ m_current

unsigned int KIGFX::CAIRO_COMPOSITOR::m_current
protected

Currently used buffer handle.

Definition at line 120 of file cairo_compositor.h.

Referenced by ClearBuffer(), GetBuffer(), and SetBuffer().

◆ m_currentAntialiasingMode

cairo_antialias_t KIGFX::CAIRO_COMPOSITOR::m_currentAntialiasingMode
protected

Definition at line 138 of file cairo_compositor.h.

Referenced by CreateBuffer(), GetAntialiasingMode(), and SetAntialiasingMode().

◆ m_currentContext

cairo_t** KIGFX::CAIRO_COMPOSITOR::m_currentContext
protected

Pointer to the current context, so it can be changed.

Definition at line 124 of file cairo_compositor.h.

Referenced by SetBuffer().

◆ m_height

unsigned int KIGFX::COMPOSITOR::m_height
protectedinherited

Height of the buffer (in pixels)

Definition at line 120 of file compositor.h.

Referenced by CreateBuffer(), KIGFX::OPENGL_COMPOSITOR::GetScreenSize(), KIGFX::OPENGL_COMPOSITOR::Resize(), and Resize().

◆ m_mainContext

cairo_t* KIGFX::CAIRO_COMPOSITOR::m_mainContext
protected

Rendering target used for compositing (the main display)

Definition at line 127 of file cairo_compositor.h.

Referenced by CreateBuffer(), DrawBuffer(), and SetMainContext().

◆ m_matrix

cairo_matrix_t KIGFX::CAIRO_COMPOSITOR::m_matrix
protected

Transformation matrix.

Definition at line 130 of file cairo_compositor.h.

Referenced by CAIRO_COMPOSITOR(), CreateBuffer(), DrawBuffer(), SetBuffer(), and SetMainContext().

◆ m_stride

unsigned int KIGFX::CAIRO_COMPOSITOR::m_stride
protected

Stride to use given the desired format and width.

Definition at line 135 of file cairo_compositor.h.

Referenced by CAIRO_COMPOSITOR(), CreateBuffer(), and Resize().

◆ m_width

unsigned int KIGFX::COMPOSITOR::m_width
protectedinherited

Width of the buffer (in pixels)

Definition at line 119 of file compositor.h.

Referenced by CreateBuffer(), KIGFX::OPENGL_COMPOSITOR::GetScreenSize(), KIGFX::OPENGL_COMPOSITOR::Resize(), and Resize().


The documentation for this class was generated from the following files: