KiCad PCB EDA Suite
Loading...
Searching...
No Matches
opengl_gal.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KICAD, a free EDA CAD application.
3 *
4 * Copyright (C) 2012 Torsten Hueter, torstenhtr <at> gmx.de
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 * Copyright (C) 2013-2017 CERN
7 * @author Maciej Suminski <[email protected]>
8 *
9 * Graphics Abstraction Layer (GAL) for OpenGL
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, you may find one here:
23 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
24 * or you may search the http://www.gnu.org website for the version 2 license,
25 * or you may write to the Free Software Foundation, Inc.,
26 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
27 */
28
29#include <kicad_gl/kiglu.h> // Must be included first
30#include <kicad_gl/gl_utils.h>
31
32#include <advanced_config.h>
33#include <build_version.h>
35#include <gal/opengl/utils.h>
36#include <gal/definitions.h>
39#include <math/vector2wx.h>
40#include <bitmap_base.h>
41#include <bezier_curves.h>
42#include <math/util.h> // for KiROUND
43#include <pgm_base.h>
44#include <trace_helpers.h>
45
46#include <wx/app.h>
47#include <wx/frame.h>
48
49#include <macros.h>
50#include <optional>
52#include <thread_pool.h>
53
54#include <core/profile.h>
55#include <trace_helpers.h>
56
57#include <functional>
58#include <limits>
59#include <memory>
60#include <list>
61using namespace std::placeholders;
62using namespace KIGFX;
63
64//#define DISABLE_BITMAP_CACHE
65
66// The current font is "Ubuntu Mono" available under Ubuntu Font Licence 1.0
67// (see ubuntu-font-licence-1.0.txt for details)
68#include "gl_resources.h"
69#include <glsl_kicad_frag.h>
70#include <glsl_kicad_vert.h>
71using namespace KIGFX::BUILTIN_FONT;
72
73static void InitTesselatorCallbacks( GLUtesselator* aTesselator );
74
75// Trace mask for XOR/difference mode debugging
76static const wxChar* const traceGalXorMode = wxT( "KICAD_GAL_XOR_MODE" );
77
78static wxGLAttributes getGLAttribs()
79{
80 wxGLAttributes attribs;
81 attribs.RGBA().DoubleBuffer().Depth( 8 ).EndList();
82
83 return attribs;
84}
85
86wxGLContext* OPENGL_GAL::m_glMainContext = nullptr;
90
91namespace KIGFX
92{
94{
95public:
97 m_cacheSize( 0 )
98 {}
99
101
102 GLuint RequestBitmap( const BITMAP_BASE* aBitmap );
103
104private:
106 {
107 GLuint id;
108 int w, h;
109 size_t size;
110 long long int accessTime;
111 };
112
113 GLuint cacheBitmap( const BITMAP_BASE* aBitmap );
114
115 const size_t m_cacheMaxElements = 50;
116 const size_t m_cacheMaxSize = 256 * 1024 * 1024;
117
118 std::map<const KIID, CACHED_BITMAP> m_bitmaps;
119 std::list<KIID> m_cacheLru;
121 std::list<GLuint> m_freedTextureIds;
122};
123
124}; // namespace KIGFX
125
126
128{
129 for( auto& bitmap : m_bitmaps )
130 glDeleteTextures( 1, &bitmap.second.id );
131}
132
133
135{
136#ifndef DISABLE_BITMAP_CACHE
137 auto it = m_bitmaps.find( aBitmap->GetImageID() );
138
139 if( it != m_bitmaps.end() )
140 {
141 // A bitmap is found in cache bitmap. Ensure the associated texture is still valid.
142 if( glIsTexture( it->second.id ) )
143 {
144 it->second.accessTime = wxGetUTCTimeMillis().GetValue();
145 return it->second.id;
146 }
147 else
148 {
149 // Delete the invalid bitmap cache and its data
150 glDeleteTextures( 1, &it->second.id );
151 m_freedTextureIds.emplace_back( it->second.id );
152
153 auto listIt = std::find( m_cacheLru.begin(), m_cacheLru.end(), it->first );
154
155 if( listIt != m_cacheLru.end() )
156 m_cacheLru.erase( listIt );
157
158 m_cacheSize -= it->second.size;
159
160 m_bitmaps.erase( it );
161 }
162
163 // the cached bitmap is not valid and deleted, it will be recreated.
164 }
165
166#endif
167 return cacheBitmap( aBitmap );
168}
169
170
172{
173 CACHED_BITMAP bmp;
174
175 const wxImage* imgPtr = aBitmap->GetOriginalImageData();
176
177 if( !imgPtr )
178 return std::numeric_limits< GLuint >::max();
179
180 const wxImage& imgData = *imgPtr;
181
182 bmp.w = imgData.GetSize().x;
183 bmp.h = imgData.GetSize().y;
184
185 GLuint textureID;
186
187 if( m_freedTextureIds.empty() )
188 {
189 glGenTextures( 1, &textureID );
190 }
191 else
192 {
193 textureID = m_freedTextureIds.front();
194 m_freedTextureIds.pop_front();
195 }
196
197 glPixelStorei( GL_UNPACK_ALIGNMENT, 1 );
198
199 if( imgData.HasAlpha() || imgData.HasMask() )
200 {
201 bmp.size = bmp.w * bmp.h * 4;
202 auto buf = std::make_unique<uint8_t[]>( bmp.size );
203
204 uint8_t* dstP = buf.get();
205 uint8_t* srcP = imgData.GetData();
206
207 long long pxCount = static_cast<long long>( bmp.w ) * bmp.h;
208
209 if( imgData.HasAlpha() )
210 {
211 uint8_t* srcAlpha = imgData.GetAlpha();
212
213 for( long long px = 0; px < pxCount; px++ )
214 {
215 memcpy( dstP, srcP, 3 );
216 dstP[3] = *srcAlpha;
217
218 srcAlpha += 1;
219 srcP += 3;
220 dstP += 4;
221 }
222 }
223 else if( imgData.HasMask() )
224 {
225 uint8_t maskRed = imgData.GetMaskRed();
226 uint8_t maskGreen = imgData.GetMaskGreen();
227 uint8_t maskBlue = imgData.GetMaskBlue();
228
229 for( long long px = 0; px < pxCount; px++ )
230 {
231 memcpy( dstP, srcP, 3 );
232
233 if( srcP[0] == maskRed && srcP[1] == maskGreen && srcP[2] == maskBlue )
234 dstP[3] = wxALPHA_TRANSPARENT;
235 else
236 dstP[3] = wxALPHA_OPAQUE;
237
238 srcP += 3;
239 dstP += 4;
240 }
241 }
242
243 glBindTexture( GL_TEXTURE_2D, textureID );
244 glTexImage2D( GL_TEXTURE_2D, 0, GL_RGBA8, bmp.w, bmp.h, 0, GL_RGBA, GL_UNSIGNED_BYTE,
245 buf.get() );
246 }
247 else
248 {
249 bmp.size = bmp.w * bmp.h * 3;
250
251 uint8_t* srcP = imgData.GetData();
252
253 glBindTexture( GL_TEXTURE_2D, textureID );
254 glTexImage2D( GL_TEXTURE_2D, 0, GL_RGB8, bmp.w, bmp.h, 0, GL_RGB, GL_UNSIGNED_BYTE, srcP );
255 }
256
257 glTexParameteri( GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST );
258 glTexParameteri( GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST );
259
260 long long currentTime = wxGetUTCTimeMillis().GetValue();
261
262 bmp.id = textureID;
263 bmp.accessTime = currentTime;
264
265#ifndef DISABLE_BITMAP_CACHE
266 if( ( m_cacheLru.size() + 1 > m_cacheMaxElements || m_cacheSize + bmp.size > m_cacheMaxSize )
267 && !m_cacheLru.empty() )
268 {
269 KIID toRemove( 0 );
270 auto toRemoveLru = m_cacheLru.end();
271
272 // Remove entries accessed > 1s ago first
273 for( const auto& [kiid, cachedBmp] : m_bitmaps )
274 {
275 const int cacheTimeoutMillis = 1000L;
276
277 if( currentTime - cachedBmp.accessTime > cacheTimeoutMillis )
278 {
279 toRemove = kiid;
280 toRemoveLru = std::find( m_cacheLru.begin(), m_cacheLru.end(), toRemove );
281 break;
282 }
283 }
284
285 // Otherwise, remove the latest entry (it's less likely to be needed soon)
286 if( toRemove == niluuid )
287 {
288 toRemoveLru = m_cacheLru.end();
289 toRemoveLru--;
290
291 toRemove = *toRemoveLru;
292 }
293
294 CACHED_BITMAP& cachedBitmap = m_bitmaps[toRemove];
295
296 m_cacheSize -= cachedBitmap.size;
297 glDeleteTextures( 1, &cachedBitmap.id );
298 m_freedTextureIds.emplace_back( cachedBitmap.id );
299
300 m_bitmaps.erase( toRemove );
301 m_cacheLru.erase( toRemoveLru );
302 }
303
304 m_cacheLru.emplace_back( aBitmap->GetImageID() );
305 m_cacheSize += bmp.size;
306 m_bitmaps.emplace( aBitmap->GetImageID(), std::move( bmp ) );
307#endif
308
309 return textureID;
310}
311
312
314 wxWindow* aParent,
315 wxEvtHandler* aMouseListener, wxEvtHandler* aPaintListener,
316 const wxString& aName ) :
317 GAL( aDisplayOptions ),
318 HIDPI_GL_CANVAS( aVcSettings, aParent, getGLAttribs(), wxID_ANY, wxDefaultPosition,
319 wxDefaultSize,
320 wxEXPAND, aName ),
321 m_mouseListener( aMouseListener ),
322 m_paintListener( aPaintListener ),
323 m_currentManager( nullptr ),
324 m_cachedManager( nullptr ),
325 m_nonCachedManager( nullptr ),
326 m_overlayManager( nullptr ),
327 m_tempManager( nullptr ),
328 m_mainBuffer( 0 ),
329 m_overlayBuffer( 0 ),
330 m_tempBuffer( 0 ),
331 m_isContextLocked( false ),
333{
334 if( m_glMainContext == nullptr )
335 {
337
338 if( !m_glMainContext )
339 throw std::runtime_error( "Could not create the main OpenGL context" );
340
342 }
343 else
344 {
346
347 if( !m_glPrivContext )
348 throw std::runtime_error( "Could not create a private OpenGL context" );
349 }
350
351 m_shader = new SHADER();
353
354 m_bitmapCache = std::make_unique<GL_BITMAP_CACHE>();
355
357 m_compositor->SetAntialiasingMode( m_options.antialiasing_mode );
358
359 // Initialize the flags
362 m_isInitialized = false;
363 m_isGrouping = false;
364 m_groupCounter = 0;
365
366 // Connect the native cursor handler
367 Connect( wxEVT_SET_CURSOR, wxSetCursorEventHandler( OPENGL_GAL::onSetNativeCursor ), nullptr,
368 this );
369
370 // Connecting the event handlers
371 Connect( wxEVT_PAINT, wxPaintEventHandler( OPENGL_GAL::onPaint ) );
372
373 // Mouse events are skipped to the parent
374 Connect( wxEVT_MOTION, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
375 Connect( wxEVT_LEFT_DOWN, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
376 Connect( wxEVT_LEFT_UP, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
377 Connect( wxEVT_LEFT_DCLICK, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
378 Connect( wxEVT_MIDDLE_DOWN, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
379 Connect( wxEVT_MIDDLE_UP, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
380 Connect( wxEVT_MIDDLE_DCLICK, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
381 Connect( wxEVT_RIGHT_DOWN, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
382 Connect( wxEVT_RIGHT_UP, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
383 Connect( wxEVT_RIGHT_DCLICK, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
384 Connect( wxEVT_AUX1_DOWN, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
385 Connect( wxEVT_AUX1_UP, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
386 Connect( wxEVT_AUX1_DCLICK, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
387 Connect( wxEVT_AUX2_DOWN, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
388 Connect( wxEVT_AUX2_UP, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
389 Connect( wxEVT_AUX2_DCLICK, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
390 Connect( wxEVT_MOUSEWHEEL, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
391 Connect( wxEVT_MAGNIFY, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
392
393#if defined _WIN32 || defined _WIN64
394 Connect( wxEVT_ENTER_WINDOW, wxMouseEventHandler( OPENGL_GAL::skipMouseEvent ) );
395#endif
396
397 Bind( wxEVT_GESTURE_ZOOM, &OPENGL_GAL::skipGestureEvent, this );
398 Bind( wxEVT_GESTURE_PAN, &OPENGL_GAL::skipGestureEvent, this );
399
400 SetSize( aParent->GetClientSize() );
402
403 // Grid color settings are different in Cairo and OpenGL
404 SetGridColor( COLOR4D( 0.8, 0.8, 0.8, 0.1 ) );
406
407 // Tesselator initialization
408 m_tesselator = gluNewTess();
410
411 gluTessProperty( m_tesselator, GLU_TESS_WINDING_RULE, GLU_TESS_WINDING_POSITIVE );
412
414
415 // Avoid uninitialized variables:
421 ufm_fontTexture = -1;
423 m_swapInterval = 0;
424}
425
426
428{
430 wxASSERT( gl_mgr );
431
432 if( gl_mgr )
433 {
434 gl_mgr->LockCtx( m_glPrivContext, this );
435
437 if( m_isInitialized )
438 glFlush();
439 gluDeleteTess( m_tesselator );
440 ClearCache();
441
442 delete m_compositor;
443
444 if( m_isInitialized )
445 {
446 delete m_cachedManager;
447 delete m_nonCachedManager;
448 delete m_overlayManager;
449 delete m_tempManager;
450 }
451
452 gl_mgr->UnlockCtx( m_glPrivContext );
453
454 // If it was the main context, then it will be deleted
455 // when the last OpenGL GAL instance is destroyed (a few lines below)
457 gl_mgr->DestroyCtx( m_glPrivContext );
458
459 delete m_shader;
460
461 // Are we destroying the last GAL instance?
462 if( m_instanceCounter == 0 )
463 {
464 gl_mgr->LockCtx( m_glMainContext, this );
465
467 {
468 glDeleteTextures( 1, &g_fontTexture );
469 m_isBitmapFontLoaded = false;
470 }
471
472 gl_mgr->UnlockCtx( m_glMainContext );
473 gl_mgr->DestroyCtx( m_glMainContext );
474 m_glMainContext = nullptr;
475 }
476 }
477}
478
479
481{
482 static std::optional<wxString> cached;
483
484 if( cached.has_value() )
485 return *cached;
486
487 wxString retVal = wxEmptyString;
488
489 wxFrame* testFrame = new wxFrame( nullptr, wxID_ANY, wxT( "" ), wxDefaultPosition,
490 wxSize( 1, 1 ), wxFRAME_TOOL_WINDOW | wxNO_BORDER );
491
492 KIGFX::OPENGL_GAL* opengl_gal = nullptr;
493
494 try
495 {
497 opengl_gal = new KIGFX::OPENGL_GAL( dummy, aOptions, testFrame );
498
499 testFrame->Raise();
500 testFrame->Show();
501
502#ifdef __WXGTK__
503 // On GTK, Show() only queues realization. The GDK drawing window
504 // needed by SetCurrent() may not exist yet. Yield to let the event
505 // loop process the realize signal before we try to lock the context.
506 wxYield();
507#endif
508
509 GAL_CONTEXT_LOCKER lock( opengl_gal );
510 opengl_gal->init();
511 }
512 catch( std::runtime_error& err )
513 {
514 //Test failed
515 retVal = wxString( err.what() );
516 }
517
518 delete opengl_gal;
519 delete testFrame;
520
521 cached = retVal;
522 return retVal;
523}
524
525
526void OPENGL_GAL::PostPaint( wxPaintEvent& aEvent )
527{
528 // posts an event to m_paint_listener to ask for redraw the canvas.
529 if( m_paintListener )
530 wxPostEvent( m_paintListener, aEvent );
531}
532
533
535{
536 GAL_CONTEXT_LOCKER lock( this );
537
538 bool refresh = false;
539
540 if( m_options.antialiasing_mode != m_compositor->GetAntialiasingMode() )
541 {
542 m_compositor->SetAntialiasingMode( m_options.antialiasing_mode );
544 refresh = true;
545 }
546
547 if( super::updatedGalDisplayOptions( aOptions ) || refresh )
548 {
549 Refresh();
550 refresh = true;
551 }
552
553 return refresh;
554}
555
556
558{
560 return std::min( std::abs( matrix.GetScale().x ), std::abs( matrix.GetScale().y ) );
561}
562
563
565{
566 double sf = GetScaleFactor();
567 return VECTOR2D( 2.0 / (double) ( m_screenSize.x * sf ), 2.0 /
568 (double) ( m_screenSize.y * sf ) );
569}
570
571
573{
574#ifdef KICAD_GAL_PROFILE
575 PROF_TIMER totalRealTime( "OPENGL_GAL::beginDrawing()", true );
576#endif /* KICAD_GAL_PROFILE */
577
578 wxASSERT_MSG( m_isContextLocked, "GAL_DRAWING_CONTEXT RAII object should have locked context. "
579 "Calling GAL::beginDrawing() directly is not allowed." );
580
581 wxASSERT_MSG( IsVisible(), "GAL::beginDrawing() must not be entered when GAL is not visible. "
582 "Other drawing routines will expect everything to be initialized "
583 "which will not be the case." );
584
585 if( !m_isInitialized )
586 init();
587
588 // Set up the view port
589 glMatrixMode( GL_PROJECTION );
590 glLoadIdentity();
591
592 // Create the screen transformation (Do the RH-LH conversion here)
593 glOrtho( 0, (GLint) m_screenSize.x, (GLsizei) m_screenSize.y, 0,
594 -m_depthRange.x, -m_depthRange.y );
595
597 {
598 // Prepare rendering target buffers
599 m_compositor->Initialize();
600 m_mainBuffer = m_compositor->CreateBuffer();
601 try
602 {
603 m_tempBuffer = m_compositor->CreateBuffer();
604 }
605 catch( const std::runtime_error& )
606 {
607 wxLogVerbose( "Could not create a framebuffer for diff mode blending.\n" );
608 m_tempBuffer = 0;
609 }
610 try
611 {
612 m_overlayBuffer = m_compositor->CreateBuffer();
613 }
614 catch( const std::runtime_error& )
615 {
616 wxLogVerbose( "Could not create a framebuffer for overlays.\n" );
617 m_overlayBuffer = 0;
618 }
619
621 }
622
623 m_compositor->Begin();
624
625 // Disable 2D Textures
626 glDisable( GL_TEXTURE_2D );
627
628 glShadeModel( GL_FLAT );
629
630 // Enable the depth buffer
631 glEnable( GL_DEPTH_TEST );
632 glDepthFunc( GL_LESS );
633
634 // Setup blending, required for transparent objects
635 glEnable( GL_BLEND );
636 glBlendFunc( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA );
637
638 glMatrixMode( GL_MODELVIEW );
639
640 // Set up the world <-> screen transformation
642 GLdouble matrixData[16] = { 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1 };
643 matrixData[0] = m_worldScreenMatrix.m_data[0][0];
644 matrixData[1] = m_worldScreenMatrix.m_data[1][0];
645 matrixData[2] = m_worldScreenMatrix.m_data[2][0];
646 matrixData[4] = m_worldScreenMatrix.m_data[0][1];
647 matrixData[5] = m_worldScreenMatrix.m_data[1][1];
648 matrixData[6] = m_worldScreenMatrix.m_data[2][1];
649 matrixData[12] = m_worldScreenMatrix.m_data[0][2];
650 matrixData[13] = m_worldScreenMatrix.m_data[1][2];
651 matrixData[14] = m_worldScreenMatrix.m_data[2][2];
652 glLoadMatrixd( matrixData );
653
654 // Set defaults
657
658 // Remove all previously stored items
659 m_nonCachedManager->Clear();
660 m_overlayManager->Clear();
661 m_tempManager->Clear();
662
663 m_cachedManager->BeginDrawing();
664 m_nonCachedManager->BeginDrawing();
665 m_overlayManager->BeginDrawing();
666 m_tempManager->BeginDrawing();
667
669 {
670 // Keep bitmap font texture always bound to the second texturing unit
671 const GLint FONT_TEXTURE_UNIT = 2;
672
673 // Either load the font atlas to video memory, or simply bind it to a texture unit
675 {
676 glActiveTexture( GL_TEXTURE0 + FONT_TEXTURE_UNIT );
677 glGenTextures( 1, &g_fontTexture );
678 glBindTexture( GL_TEXTURE_2D, g_fontTexture );
679 glTexImage2D( GL_TEXTURE_2D, 0, GL_RGB8, font_image.width, font_image.height, 0, GL_RGB,
680 GL_UNSIGNED_BYTE, font_image.pixels );
681 glTexParameteri( GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR );
682 glTexParameteri( GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR );
683 checkGlError( "loading bitmap font", __FILE__, __LINE__ );
684
685 glActiveTexture( GL_TEXTURE0 );
686
688 }
689 else
690 {
691 glActiveTexture( GL_TEXTURE0 + FONT_TEXTURE_UNIT );
692 glBindTexture( GL_TEXTURE_2D, g_fontTexture );
693 glActiveTexture( GL_TEXTURE0 );
694 }
695
696 m_shader->Use();
697 m_shader->SetParameter( ufm_fontTexture, (int) FONT_TEXTURE_UNIT );
698 m_shader->SetParameter( ufm_fontTextureWidth, (int) font_image.width );
699 m_shader->Deactivate();
700 checkGlError( "setting bitmap font sampler as shader parameter", __FILE__, __LINE__ );
701
703 }
704
705 m_shader->Use();
706 m_shader->SetParameter( ufm_worldPixelSize,
707 (float) ( getWorldPixelSize() / GetScaleFactor() ) );
708 const VECTOR2D& screenPixelSize = getScreenPixelSize();
709 m_shader->SetParameter( ufm_screenPixelSize, screenPixelSize );
710 double pixelSizeMultiplier = m_compositor->GetAntialiasSupersamplingFactor();
711 m_shader->SetParameter( ufm_pixelSizeMultiplier, (float) pixelSizeMultiplier );
712 VECTOR2D renderingOffset = m_compositor->GetAntialiasRenderingOffset();
713 renderingOffset.x *= screenPixelSize.x;
714 renderingOffset.y *= screenPixelSize.y;
715 m_shader->SetParameter( ufm_antialiasingOffset, renderingOffset );
717 m_shader->Deactivate();
718
719 // Something between BeginDrawing and EndDrawing seems to depend on
720 // this texture unit being active, but it does not assure it itself.
721 glActiveTexture( GL_TEXTURE0 );
722
723 // Unbind buffers - set compositor for direct drawing
725
726#ifdef KICAD_GAL_PROFILE
727 totalRealTime.Stop();
728 wxLogTrace( traceGalProfile, wxT( "OPENGL_GAL::beginDrawing(): %.1f ms" ),
729 totalRealTime.msecs() );
730#endif /* KICAD_GAL_PROFILE */
731}
732
733void OPENGL_GAL::SetMinLineWidth( float aLineWidth )
734{
735 GAL::SetMinLineWidth( aLineWidth );
736
737 if( m_shader && ufm_minLinePixelWidth != -1 )
738 {
739 m_shader->Use();
740 m_shader->SetParameter( ufm_minLinePixelWidth, aLineWidth );
741 m_shader->Deactivate();
742 }
743}
744
745
747{
748 wxASSERT_MSG( m_isContextLocked, "What happened to the context lock?" );
749
750 PROF_TIMER cntTotal( "gl-end-total" );
751 PROF_TIMER cntEndCached( "gl-end-cached" );
752 PROF_TIMER cntEndNoncached( "gl-end-noncached" );
753 PROF_TIMER cntEndOverlay( "gl-end-overlay" );
754 PROF_TIMER cntComposite( "gl-composite" );
755 PROF_TIMER cntSwap( "gl-swap" );
756
757 cntTotal.Start();
758
759 // Cached & non-cached containers are rendered to the same buffer
760 m_compositor->SetBuffer( m_mainBuffer );
761
762 cntEndNoncached.Start();
763 m_nonCachedManager->EndDrawing();
764 cntEndNoncached.Stop();
765
766 cntEndCached.Start();
767 m_cachedManager->EndDrawing();
768 cntEndCached.Stop();
769
770 cntEndOverlay.Start();
771 // Overlay container is rendered to a different buffer
772 if( m_overlayBuffer )
773 m_compositor->SetBuffer( m_overlayBuffer );
774
775 m_overlayManager->EndDrawing();
776 cntEndOverlay.Stop();
777
778 cntComposite.Start();
779
780 // Be sure that the framebuffer is not colorized (happens on specific GPU&drivers combinations)
781 glColor4d( 1.0, 1.0, 1.0, 1.0 );
782
783 // Draw the remaining contents, blit the rendering targets to the screen, swap the buffers
784 m_compositor->DrawBuffer( m_mainBuffer );
785
786 if( m_overlayBuffer )
787 m_compositor->DrawBuffer( m_overlayBuffer );
788
789 m_compositor->Present();
790 blitCursor();
791
792 cntComposite.Stop();
793
794 cntSwap.Start();
795 SwapBuffers();
796 cntSwap.Stop();
797
798 cntTotal.Stop();
799
800 KI_TRACE( traceGalProfile, "Timing: %s %s %s %s %s %s\n", cntTotal.to_string(),
801 cntEndCached.to_string(), cntEndNoncached.to_string(), cntEndOverlay.to_string(),
802 cntComposite.to_string(), cntSwap.to_string() );
803}
804
805
806void OPENGL_GAL::LockContext( int aClientCookie )
807{
808 wxASSERT_MSG( !m_isContextLocked, "Context already locked." );
809 m_isContextLocked = true;
810 m_lockClientCookie = aClientCookie;
811
813}
814
815
816void OPENGL_GAL::UnlockContext( int aClientCookie )
817{
818 wxASSERT_MSG( m_isContextLocked, "Context not locked. A GAL_CONTEXT_LOCKER RAII object must "
819 "be stacked rather than making separate lock/unlock calls." );
820
821 wxASSERT_MSG( m_lockClientCookie == aClientCookie,
822 "Context was locked by a different client. "
823 "Should not be possible with RAII objects." );
824
825 m_isContextLocked = false;
826
828}
829
830
832{
833 wxASSERT_MSG( m_isContextLocked, "GAL_UPDATE_CONTEXT RAII object should have locked context. "
834 "Calling this from anywhere else is not allowed." );
835
836 wxASSERT_MSG( IsVisible(), "GAL::beginUpdate() must not be entered when GAL is not visible. "
837 "Other update routines will expect everything to be initialized "
838 "which will not be the case." );
839
840 if( !m_isInitialized )
841 init();
842
843 m_cachedManager->Map();
844}
845
846
848{
849 if( !m_isInitialized )
850 return;
851
852 m_cachedManager->Unmap();
853}
854
855
856void OPENGL_GAL::DrawLine( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint )
857{
859
860 drawLineQuad( aStartPoint, aEndPoint );
861}
862
863
864void OPENGL_GAL::DrawSegment( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint,
865 double aWidth )
866{
867 drawSegment( aStartPoint, aEndPoint, aWidth );
868}
869
870
871void OPENGL_GAL::drawSegment( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint, double aWidth,
872 bool aReserve )
873{
874 VECTOR2D startEndVector = aEndPoint - aStartPoint;
875 double lineLength = startEndVector.EuclideanNorm();
876
877 // Be careful about floating point rounding. As we draw segments in larger and larger
878 // coordinates, the shader (which uses floats) will lose precision and stop drawing small
879 // segments. In this case, we need to draw a circle for the minimal segment.
880 // Check if the coordinate differences can be accurately represented as floats
881 float startX = static_cast<float>( aStartPoint.x );
882 float startY = static_cast<float>( aStartPoint.y );
883 float endX = static_cast<float>( aEndPoint.x );
884 float endY = static_cast<float>( aEndPoint.y );
885
886 if( startX == endX && startY == endY )
887 {
888 drawCircle( aStartPoint, aWidth / 2, aReserve );
889 return;
890 }
891
892 if( m_isFillEnabled || aWidth == 1.0 )
893 {
895
896 SetLineWidth( aWidth );
897 drawLineQuad( aStartPoint, aEndPoint, aReserve );
898 }
899 else
900 {
901 EDA_ANGLE lineAngle( startEndVector );
902
903 // Outlined tracks
904 SetLineWidth( 1.0 );
906 m_strokeColor.a );
907
908 Save();
909
910 if( aReserve )
911 m_currentManager->Reserve( 6 + 6 + 3 + 3 ); // Two line quads and two semicircles
912
913 m_currentManager->Translate( aStartPoint.x, aStartPoint.y, 0.0 );
914 m_currentManager->Rotate( lineAngle.AsRadians(), 0.0f, 0.0f, 1.0f );
915
916 drawLineQuad( VECTOR2D( 0.0, aWidth / 2.0 ), VECTOR2D( lineLength, aWidth / 2.0 ), false );
917
918 drawLineQuad( VECTOR2D( 0.0, -aWidth / 2.0 ), VECTOR2D( lineLength, -aWidth / 2.0 ),
919 false );
920
921 // Draw line caps
922 drawStrokedSemiCircle( VECTOR2D( 0.0, 0.0 ), aWidth / 2, M_PI / 2, false );
923 drawStrokedSemiCircle( VECTOR2D( lineLength, 0.0 ), aWidth / 2, -M_PI / 2, false );
924
925 Restore();
926 }
927}
928
929
930void OPENGL_GAL::DrawCircle( const VECTOR2D& aCenterPoint, double aRadius )
931{
932 drawCircle( aCenterPoint, aRadius );
933}
934
935
936void OPENGL_GAL::DrawHoleWall( const VECTOR2D& aCenterPoint, double aHoleRadius,
937 double aWallWidth )
938{
939 if( m_isFillEnabled )
940 {
942
943 m_currentManager->Shader( SHADER_HOLE_WALL, 1.0, aHoleRadius, aWallWidth );
944 m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, m_layerDepth );
945
946 m_currentManager->Shader( SHADER_HOLE_WALL, 2.0, aHoleRadius, aWallWidth );
947 m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, m_layerDepth );
948
949 m_currentManager->Shader( SHADER_HOLE_WALL, 3.0, aHoleRadius, aWallWidth );
950 m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, m_layerDepth );
951 }
952}
953
954
955void OPENGL_GAL::drawCircle( const VECTOR2D& aCenterPoint, double aRadius, bool aReserve )
956{
957 if( m_isFillEnabled )
958 {
959 if( aReserve )
960 m_currentManager->Reserve( 3 );
961
963
964 /* Draw a triangle that contains the circle, then shade it leaving only the circle.
965 * Parameters given to Shader() are indices of the triangle's vertices
966 * (if you want to understand more, check the vertex shader source [shader.vert]).
967 * Shader uses this coordinates to determine if fragments are inside the circle or not.
968 * Does the calculations in the vertex shader now (pixel alignment)
969 * v2
970 * /\
971 * //\\
972 * v0 /_\/_\ v1
973 */
974 m_currentManager->Shader( SHADER_FILLED_CIRCLE, 1.0, aRadius );
975 m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, m_layerDepth );
976
977 m_currentManager->Shader( SHADER_FILLED_CIRCLE, 2.0, aRadius );
978 m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, m_layerDepth );
979
980 m_currentManager->Shader( SHADER_FILLED_CIRCLE, 3.0, aRadius );
981 m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, m_layerDepth );
982 }
983
985 {
986 if( aReserve )
987 m_currentManager->Reserve( 3 );
988
990 m_strokeColor.a );
991
992 /* Draw a triangle that contains the circle, then shade it leaving only the circle.
993 * Parameters given to Shader() are indices of the triangle's vertices
994 * (if you want to understand more, check the vertex shader source [shader.vert]).
995 * and the line width. Shader uses this coordinates to determine if fragments are
996 * inside the circle or not.
997 * v2
998 * /\
999 * //\\
1000 * v0 /_\/_\ v1
1001 */
1002 m_currentManager->Shader( SHADER_STROKED_CIRCLE, 1.0, aRadius, m_lineWidth );
1003 m_currentManager->Vertex( aCenterPoint.x, // v0
1004 aCenterPoint.y, m_layerDepth );
1005
1006 m_currentManager->Shader( SHADER_STROKED_CIRCLE, 2.0, aRadius, m_lineWidth );
1007 m_currentManager->Vertex( aCenterPoint.x, // v1
1008 aCenterPoint.y, m_layerDepth );
1009
1010 m_currentManager->Shader( SHADER_STROKED_CIRCLE, 3.0, aRadius, m_lineWidth );
1011 m_currentManager->Vertex( aCenterPoint.x, aCenterPoint.y, // v2
1012 m_layerDepth );
1013 }
1014}
1015
1016
1017void OPENGL_GAL::DrawArc( const VECTOR2D& aCenterPoint, double aRadius,
1018 const EDA_ANGLE& aStartAngle, const EDA_ANGLE& aAngle )
1019{
1020 if( aRadius <= 0 )
1021 return;
1022
1023 double startAngle = aStartAngle.AsRadians();
1024 double endAngle = startAngle + aAngle.AsRadians();
1025
1026 // Normalize arc angles
1027 normalize( startAngle, endAngle );
1028
1029 const double alphaIncrement = calcAngleStep( aRadius );
1030
1031 Save();
1032 m_currentManager->Translate( aCenterPoint.x, aCenterPoint.y, 0.0 );
1033
1034 if( m_isFillEnabled )
1035 {
1036 double alpha;
1038 m_currentManager->Shader( SHADER_NONE );
1039
1040 // Triangle fan
1041 for( alpha = startAngle; ( alpha + alphaIncrement ) < endAngle; )
1042 {
1043 m_currentManager->Reserve( 3 );
1044 m_currentManager->Vertex( 0.0, 0.0, m_layerDepth );
1045 m_currentManager->Vertex( cos( alpha ) * aRadius, sin( alpha ) * aRadius,
1046 m_layerDepth );
1047 alpha += alphaIncrement;
1048 m_currentManager->Vertex( cos( alpha ) * aRadius, sin( alpha ) * aRadius,
1049 m_layerDepth );
1050 }
1051
1052 // The last missing triangle
1053 const VECTOR2D endPoint( cos( endAngle ) * aRadius, sin( endAngle ) * aRadius );
1054
1055 m_currentManager->Reserve( 3 );
1056 m_currentManager->Vertex( 0.0, 0.0, m_layerDepth );
1057 m_currentManager->Vertex( cos( alpha ) * aRadius, sin( alpha ) * aRadius, m_layerDepth );
1058 m_currentManager->Vertex( endPoint.x, endPoint.y, m_layerDepth );
1059 }
1060
1061 if( m_isStrokeEnabled )
1062 {
1064 m_strokeColor.a );
1065
1066 VECTOR2D p( cos( startAngle ) * aRadius, sin( startAngle ) * aRadius );
1067 double alpha;
1068 unsigned int lineCount = 0;
1069
1070 for( alpha = startAngle + alphaIncrement; alpha <= endAngle; alpha += alphaIncrement )
1071 lineCount++;
1072
1073 if( alpha != endAngle )
1074 lineCount++;
1075
1076 reserveLineQuads( lineCount );
1077
1078 for( alpha = startAngle + alphaIncrement; alpha <= endAngle; alpha += alphaIncrement )
1079 {
1080 VECTOR2D p_next( cos( alpha ) * aRadius, sin( alpha ) * aRadius );
1081 drawLineQuad( p, p_next, false );
1082
1083 p = p_next;
1084 }
1085
1086 // Draw the last missing part
1087 if( alpha != endAngle )
1088 {
1089 VECTOR2D p_last( cos( endAngle ) * aRadius, sin( endAngle ) * aRadius );
1090 drawLineQuad( p, p_last, false );
1091 }
1092 }
1093
1094 Restore();
1095}
1096
1097
1098void OPENGL_GAL::DrawArcSegment( const VECTOR2D& aCenterPoint, double aRadius,
1099 const EDA_ANGLE& aStartAngle, const EDA_ANGLE& aAngle,
1100 double aWidth, double aMaxError )
1101{
1102 if( aRadius <= 0 )
1103 {
1104 // Arcs of zero radius are a circle of aWidth diameter
1105 if( aWidth > 0 )
1106 DrawCircle( aCenterPoint, aWidth / 2.0 );
1107
1108 return;
1109 }
1110
1111 double startAngle = aStartAngle.AsRadians();
1112 double endAngle = startAngle + aAngle.AsRadians();
1113
1114 // Swap the angles, if start angle is greater than end angle
1115 normalize( startAngle, endAngle );
1116
1117 // Calculate the seg count to approximate the arc with aMaxError or less
1118 int segCount360 = GetArcToSegmentCount( aRadius, aMaxError, FULL_CIRCLE );
1119 segCount360 = std::max( SEG_PER_CIRCLE_COUNT, segCount360 );
1120 double alphaIncrement = 2.0 * M_PI / segCount360;
1121
1122 // Refinement: Use a segment count multiple of 2, because we have a control point
1123 // on the middle of the arc, and the look is better if it is on a segment junction
1124 // because there is no approx error
1125 int seg_count = KiROUND( ( endAngle - startAngle ) / alphaIncrement );
1126
1127 if( seg_count % 2 != 0 )
1128 seg_count += 1;
1129
1130 // Our shaders have trouble rendering null line quads, so delegate this task to DrawSegment.
1131 if( seg_count == 0 )
1132 {
1133 VECTOR2D p_start( aCenterPoint.x + cos( startAngle ) * aRadius,
1134 aCenterPoint.y + sin( startAngle ) * aRadius );
1135
1136 VECTOR2D p_end( aCenterPoint.x + cos( endAngle ) * aRadius,
1137 aCenterPoint.y + sin( endAngle ) * aRadius );
1138
1139 DrawSegment( p_start, p_end, aWidth );
1140 return;
1141 }
1142
1143 // Recalculate alphaIncrement with a even integer number of segment
1144 alphaIncrement = ( endAngle - startAngle ) / seg_count;
1145
1146 Save();
1147 m_currentManager->Translate( aCenterPoint.x, aCenterPoint.y, 0.0 );
1148
1149 if( m_isStrokeEnabled )
1150 {
1152 m_strokeColor.a );
1153
1154 double width = aWidth / 2.0;
1155 VECTOR2D startPoint( cos( startAngle ) * aRadius, sin( startAngle ) * aRadius );
1156 VECTOR2D endPoint( cos( endAngle ) * aRadius, sin( endAngle ) * aRadius );
1157
1158 drawStrokedSemiCircle( startPoint, width, startAngle + M_PI );
1159 drawStrokedSemiCircle( endPoint, width, endAngle );
1160
1161 VECTOR2D pOuter( cos( startAngle ) * ( aRadius + width ),
1162 sin( startAngle ) * ( aRadius + width ) );
1163
1164 VECTOR2D pInner( cos( startAngle ) * ( aRadius - width ),
1165 sin( startAngle ) * ( aRadius - width ) );
1166
1167 double alpha;
1168
1169 for( alpha = startAngle + alphaIncrement; alpha <= endAngle; alpha += alphaIncrement )
1170 {
1171 VECTOR2D pNextOuter( cos( alpha ) * ( aRadius + width ),
1172 sin( alpha ) * ( aRadius + width ) );
1173 VECTOR2D pNextInner( cos( alpha ) * ( aRadius - width ),
1174 sin( alpha ) * ( aRadius - width ) );
1175
1176 DrawLine( pOuter, pNextOuter );
1177 DrawLine( pInner, pNextInner );
1178
1179 pOuter = pNextOuter;
1180 pInner = pNextInner;
1181 }
1182
1183 // Draw the last missing part
1184 if( alpha != endAngle )
1185 {
1186 VECTOR2D pLastOuter( cos( endAngle ) * ( aRadius + width ),
1187 sin( endAngle ) * ( aRadius + width ) );
1188 VECTOR2D pLastInner( cos( endAngle ) * ( aRadius - width ),
1189 sin( endAngle ) * ( aRadius - width ) );
1190
1191 DrawLine( pOuter, pLastOuter );
1192 DrawLine( pInner, pLastInner );
1193 }
1194 }
1195
1196 if( m_isFillEnabled )
1197 {
1199 SetLineWidth( aWidth );
1200
1201 VECTOR2D p( cos( startAngle ) * aRadius, sin( startAngle ) * aRadius );
1202 double alpha;
1203
1204 int lineCount = 0;
1205
1206 for( alpha = startAngle + alphaIncrement; alpha <= endAngle; alpha += alphaIncrement )
1207 {
1208 lineCount++;
1209 }
1210
1211 // The last missing part
1212 if( alpha != endAngle )
1213 {
1214 lineCount++;
1215 }
1216
1217 reserveLineQuads( lineCount );
1218
1219 for( alpha = startAngle + alphaIncrement; alpha <= endAngle; alpha += alphaIncrement )
1220 {
1221 VECTOR2D p_next( cos( alpha ) * aRadius, sin( alpha ) * aRadius );
1222 drawLineQuad( p, p_next, false );
1223
1224 p = p_next;
1225 }
1226
1227 // Draw the last missing part
1228 if( alpha != endAngle )
1229 {
1230 VECTOR2D p_last( cos( endAngle ) * aRadius, sin( endAngle ) * aRadius );
1231 drawLineQuad( p, p_last, false );
1232 }
1233 }
1234
1235 Restore();
1236}
1237
1238
1239void OPENGL_GAL::DrawRectangle( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint )
1240{
1241 // Compute the diagonal points of the rectangle
1242 VECTOR2D diagonalPointA( aEndPoint.x, aStartPoint.y );
1243 VECTOR2D diagonalPointB( aStartPoint.x, aEndPoint.y );
1244
1245 // Fill the rectangle
1246 if( m_isFillEnabled )
1247 {
1248 m_currentManager->Reserve( 6 );
1249 m_currentManager->Shader( SHADER_NONE );
1251
1252 m_currentManager->Vertex( aStartPoint.x, aStartPoint.y, m_layerDepth );
1253 m_currentManager->Vertex( diagonalPointA.x, diagonalPointA.y, m_layerDepth );
1254 m_currentManager->Vertex( aEndPoint.x, aEndPoint.y, m_layerDepth );
1255
1256 m_currentManager->Vertex( aStartPoint.x, aStartPoint.y, m_layerDepth );
1257 m_currentManager->Vertex( aEndPoint.x, aEndPoint.y, m_layerDepth );
1258 m_currentManager->Vertex( diagonalPointB.x, diagonalPointB.y, m_layerDepth );
1259 }
1260
1261 // Stroke the outline
1262 if( m_isStrokeEnabled )
1263 {
1265 m_strokeColor.a );
1266
1267 // DrawLine (and DrawPolyline )
1268 // has problem with 0 length lines so enforce minimum
1269 if( aStartPoint == aEndPoint )
1270 {
1271 DrawLine( aStartPoint + VECTOR2D( 1.0, 0.0 ), aEndPoint );
1272 }
1273 else
1274 {
1275 std::deque<VECTOR2D> pointList;
1276
1277 pointList.push_back( aStartPoint );
1278 pointList.push_back( diagonalPointA );
1279 pointList.push_back( aEndPoint );
1280 pointList.push_back( diagonalPointB );
1281 pointList.push_back( aStartPoint );
1282 DrawPolyline( pointList );
1283 }
1284 }
1285}
1286
1287
1288void OPENGL_GAL::DrawSegmentChain( const std::vector<VECTOR2D>& aPointList, double aWidth )
1289{
1291 [&]( int idx )
1292 {
1293 return aPointList[idx];
1294 },
1295 aPointList.size(), aWidth );
1296}
1297
1298
1299void OPENGL_GAL::DrawSegmentChain( const SHAPE_LINE_CHAIN& aLineChain, double aWidth )
1300{
1301 auto numPoints = aLineChain.PointCount();
1302
1303 if( aLineChain.IsClosed() )
1304 numPoints += 1;
1305
1307 [&]( int idx )
1308 {
1309 return aLineChain.CPoint( idx );
1310 },
1311 numPoints, aWidth );
1312}
1313
1314
1315void OPENGL_GAL::DrawPolyline( const std::deque<VECTOR2D>& aPointList )
1316{
1318 [&]( int idx )
1319 {
1320 return aPointList[idx];
1321 },
1322 aPointList.size() );
1323}
1324
1325
1326void OPENGL_GAL::DrawPolyline( const std::vector<VECTOR2D>& aPointList )
1327{
1329 [&]( int idx )
1330 {
1331 return aPointList[idx];
1332 },
1333 aPointList.size() );
1334}
1335
1336
1337void OPENGL_GAL::DrawPolyline( const VECTOR2D aPointList[], int aListSize )
1338{
1340 [&]( int idx )
1341 {
1342 return aPointList[idx];
1343 },
1344 aListSize );
1345}
1346
1347
1349{
1350 auto numPoints = aLineChain.PointCount();
1351
1352 if( aLineChain.IsClosed() )
1353 numPoints += 1;
1354
1356 [&]( int idx )
1357 {
1358 return aLineChain.CPoint( idx );
1359 },
1360 numPoints );
1361}
1362
1363
1364void OPENGL_GAL::DrawPolylines( const std::vector<std::vector<VECTOR2D>>& aPointList )
1365{
1366 int lineQuadCount = 0;
1367
1368 for( const std::vector<VECTOR2D>& points : aPointList )
1369 lineQuadCount += points.size() - 1;
1370
1371 reserveLineQuads( lineQuadCount );
1372
1373 for( const std::vector<VECTOR2D>& points : aPointList )
1374 {
1376 [&]( int idx )
1377 {
1378 return points[idx];
1379 },
1380 points.size(), false );
1381 }
1382}
1383
1384
1385void OPENGL_GAL::DrawPolygon( const std::deque<VECTOR2D>& aPointList )
1386{
1387 wxCHECK( aPointList.size() >= 2, /* void */ );
1388 auto points = std::unique_ptr<GLdouble[]>( new GLdouble[3 * aPointList.size()] );
1389 GLdouble* ptr = points.get();
1390
1391 for( const VECTOR2D& p : aPointList )
1392 {
1393 *ptr++ = p.x;
1394 *ptr++ = p.y;
1395 *ptr++ = m_layerDepth;
1396 }
1397
1398 drawPolygon( points.get(), aPointList.size() );
1399}
1400
1401
1402void OPENGL_GAL::DrawPolygon( const VECTOR2D aPointList[], int aListSize )
1403{
1404 wxCHECK( aListSize >= 2, /* void */ );
1405 auto points = std::unique_ptr<GLdouble[]>( new GLdouble[3 * aListSize] );
1406 GLdouble* target = points.get();
1407 const VECTOR2D* src = aPointList;
1408
1409 for( int i = 0; i < aListSize; ++i )
1410 {
1411 *target++ = src->x;
1412 *target++ = src->y;
1413 *target++ = m_layerDepth;
1414 ++src;
1415 }
1416
1417 drawPolygon( points.get(), aListSize );
1418}
1419
1420
1422 bool aStrokeTriangulation )
1423{
1424 m_currentManager->Shader( SHADER_NONE );
1426
1427 if( m_isFillEnabled )
1428 {
1429 int totalTriangleCount = 0;
1430
1431 for( unsigned int j = 0; j < aPolySet.TriangulatedPolyCount(); ++j )
1432 {
1433 auto triPoly = aPolySet.TriangulatedPolygon( j );
1434
1435 totalTriangleCount += triPoly->GetTriangleCount();
1436 }
1437
1438 m_currentManager->Reserve( 3 * totalTriangleCount );
1439
1440 for( unsigned int j = 0; j < aPolySet.TriangulatedPolyCount(); ++j )
1441 {
1442 auto triPoly = aPolySet.TriangulatedPolygon( j );
1443
1444 for( size_t i = 0; i < triPoly->GetTriangleCount(); i++ )
1445 {
1446 VECTOR2I a, b, c;
1447 triPoly->GetTriangle( i, a, b, c );
1448 m_currentManager->Vertex( a.x, a.y, m_layerDepth );
1449 m_currentManager->Vertex( b.x, b.y, m_layerDepth );
1450 m_currentManager->Vertex( c.x, c.y, m_layerDepth );
1451 }
1452 }
1453 }
1454
1455 if( m_isStrokeEnabled )
1456 {
1457 for( int j = 0; j < aPolySet.OutlineCount(); ++j )
1458 {
1459 const auto& poly = aPolySet.Polygon( j );
1460
1461 for( const auto& lc : poly )
1462 {
1463 DrawPolyline( lc );
1464 }
1465 }
1466 }
1467
1468 if( ADVANCED_CFG::GetCfg().m_DrawTriangulationOutlines )
1469 {
1470 aStrokeTriangulation = true;
1471 SetStrokeColor( COLOR4D( 0.0, 1.0, 0.2, 1.0 ) );
1472 }
1473
1474 if( aStrokeTriangulation )
1475 {
1478
1479 for( unsigned int j = 0; j < aPolySet.TriangulatedPolyCount(); ++j )
1480 {
1481 auto triPoly = aPolySet.TriangulatedPolygon( j );
1482
1483 for( size_t i = 0; i < triPoly->GetTriangleCount(); i++ )
1484 {
1485 VECTOR2I a, b, c;
1486 triPoly->GetTriangle( i, a, b, c );
1487 DrawLine( a, b );
1488 DrawLine( b, c );
1489 DrawLine( c, a );
1490 }
1491 }
1492 }
1493}
1494
1495
1496void OPENGL_GAL::DrawPolygon( const SHAPE_POLY_SET& aPolySet, bool aStrokeTriangulation )
1497{
1498 if( aPolySet.IsTriangulationUpToDate() )
1499 {
1500 drawTriangulatedPolyset( aPolySet, aStrokeTriangulation );
1501 return;
1502 }
1503
1504 for( int j = 0; j < aPolySet.OutlineCount(); ++j )
1505 {
1506 const SHAPE_LINE_CHAIN& outline = aPolySet.COutline( j );
1507 DrawPolygon( outline );
1508 }
1509}
1510
1511
1513{
1514 if( aPolygon.PointCount() < 2 )
1515 return;
1516
1517 const int pointCount = aPolygon.SegmentCount() + 1;
1518 std::unique_ptr<GLdouble[]> points( new GLdouble[3 * pointCount] );
1519 GLdouble* ptr = points.get();
1520
1521 for( int i = 0; i < pointCount; ++i )
1522 {
1523 const VECTOR2I& p = aPolygon.CPoint( i );
1524 *ptr++ = p.x;
1525 *ptr++ = p.y;
1526 *ptr++ = m_layerDepth;
1527 }
1528
1529 drawPolygon( points.get(), pointCount );
1530}
1531
1532
1533void OPENGL_GAL::DrawCurve( const VECTOR2D& aStartPoint, const VECTOR2D& aControlPointA,
1534 const VECTOR2D& aControlPointB, const VECTOR2D& aEndPoint,
1535 double aFilterValue )
1536{
1537 std::vector<VECTOR2D> output;
1538 std::vector<VECTOR2D> pointCtrl;
1539
1540 pointCtrl.push_back( aStartPoint );
1541 pointCtrl.push_back( aControlPointA );
1542 pointCtrl.push_back( aControlPointB );
1543 pointCtrl.push_back( aEndPoint );
1544
1545 BEZIER_POLY converter( pointCtrl );
1546 converter.GetPoly( output, aFilterValue );
1547
1548 if( output.size() == 1 )
1549 output.push_back( output.front() );
1550
1551 DrawPolygon( &output[0], output.size() );
1552}
1553
1554
1555void OPENGL_GAL::DrawBitmap( const BITMAP_BASE& aBitmap, double alphaBlend )
1556{
1557 GLfloat alpha = std::clamp( alphaBlend, 0.0, 1.0 );
1558
1559 // We have to calculate the pixel size in users units to draw the image.
1560 // m_worldUnitLength is a factor used for converting IU to inches
1561 double scale = 1.0 / ( aBitmap.GetPPI() * m_worldUnitLength );
1562 double w = (double) aBitmap.GetSizePixels().x * scale;
1563 double h = (double) aBitmap.GetSizePixels().y * scale;
1564
1565 auto xform = m_currentManager->GetTransformation();
1566
1567 glm::vec4 v0 = xform * glm::vec4( -w / 2, -h / 2, 0.0, 0.0 );
1568 glm::vec4 v1 = xform * glm::vec4( w / 2, h / 2, 0.0, 0.0 );
1569 glm::vec4 trans = xform[3];
1570
1571 auto texture_id = m_bitmapCache->RequestBitmap( &aBitmap );
1572
1573 if( !glIsTexture( texture_id ) ) // ensure the bitmap texture is still valid
1574 return;
1575
1576 GLboolean depthMask = GL_TRUE;
1577 glGetBooleanv( GL_DEPTH_WRITEMASK, &depthMask );
1578
1579 if( alpha < 1.0f )
1580 glDepthMask( GL_FALSE );
1581
1582 glDepthFunc( GL_ALWAYS );
1583
1584 glAlphaFunc( GL_GREATER, 0.01f );
1585 glEnable( GL_ALPHA_TEST );
1586
1587 glMatrixMode( GL_TEXTURE );
1588 glPushMatrix();
1589 glTranslated( 0.5, 0.5, 0.5 );
1590 glRotated( aBitmap.Rotation().AsDegrees(), 0, 0, 1 );
1591 glTranslated( -0.5, -0.5, -0.5 );
1592
1593 glMatrixMode( GL_MODELVIEW );
1594 glPushMatrix();
1595 glTranslated( trans.x, trans.y, trans.z );
1596
1597 glEnable( GL_TEXTURE_2D );
1598 glActiveTexture( GL_TEXTURE0 );
1599 glBindTexture( GL_TEXTURE_2D, texture_id );
1600
1601 float texStartX = aBitmap.IsMirroredX() ? 1.0 : 0.0;
1602 float texEndX = aBitmap.IsMirroredX() ? 0.0 : 1.0;
1603 float texStartY = aBitmap.IsMirroredY() ? 1.0 : 0.0;
1604 float texEndY = aBitmap.IsMirroredY() ? 0.0 : 1.0;
1605
1606 glBegin( GL_QUADS );
1607 glColor4f( 1.0, 1.0, 1.0, alpha );
1608 glTexCoord2f( texStartX, texStartY );
1609 glVertex3f( v0.x, v0.y, m_layerDepth );
1610 glColor4f( 1.0, 1.0, 1.0, alpha );
1611 glTexCoord2f( texEndX, texStartY);
1612 glVertex3f( v1.x, v0.y, m_layerDepth );
1613 glColor4f( 1.0, 1.0, 1.0, alpha );
1614 glTexCoord2f( texEndX, texEndY);
1615 glVertex3f( v1.x, v1.y, m_layerDepth );
1616 glColor4f( 1.0, 1.0, 1.0, alpha );
1617 glTexCoord2f( texStartX, texEndY);
1618 glVertex3f( v0.x, v1.y, m_layerDepth );
1619 glEnd();
1620
1621 glBindTexture( GL_TEXTURE_2D, 0 );
1622
1623#ifdef DISABLE_BITMAP_CACHE
1624 glDeleteTextures( 1, &texture_id );
1625#endif
1626
1627 glPopMatrix();
1628
1629 glMatrixMode( GL_TEXTURE );
1630 glPopMatrix();
1631 glMatrixMode( GL_MODELVIEW );
1632
1633 glDisable( GL_ALPHA_TEST );
1634
1635 glDepthMask( depthMask );
1636
1637 glDepthFunc( GL_LESS );
1638}
1639
1640
1641void OPENGL_GAL::BitmapText( const wxString& aText, const VECTOR2I& aPosition,
1642 const EDA_ANGLE& aAngle )
1643{
1644 // Fallback to generic impl (which uses the stroke font) on cases we don't handle
1645 if( IsTextMirrored()
1646 || aText.Contains( wxT( "^{" ) )
1647 || aText.Contains( wxT( "_{" ) )
1648 || aText.Contains( wxT( "\n" ) ) )
1649 {
1650 return GAL::BitmapText( aText, aPosition, aAngle );
1651 }
1652
1653 const UTF8 text( aText );
1654 VECTOR2D textSize;
1655 float commonOffset;
1656 std::tie( textSize, commonOffset ) = computeBitmapTextSize( text );
1657
1658 const double SCALE = 1.4 * GetGlyphSize().y / textSize.y;
1659 double overbarHeight = textSize.y;
1660
1661 Save();
1662
1664 m_currentManager->Translate( aPosition.x, aPosition.y, m_layerDepth );
1665 m_currentManager->Rotate( aAngle.AsRadians(), 0.0f, 0.0f, -1.0f );
1666
1667 double sx = SCALE * ( m_globalFlipX ? -1.0 : 1.0 );
1668 double sy = SCALE * ( m_globalFlipY ? -1.0 : 1.0 );
1669
1670 m_currentManager->Scale( sx, sy, 0 );
1671 m_currentManager->Translate( 0, -commonOffset, 0 );
1672
1673 switch( GetHorizontalJustify() )
1674 {
1676 Translate( VECTOR2D( -textSize.x / 2.0, 0 ) );
1677 break;
1678
1680 //if( !IsTextMirrored() )
1681 Translate( VECTOR2D( -textSize.x, 0 ) );
1682 break;
1683
1685 //if( IsTextMirrored() )
1686 //Translate( VECTOR2D( -textSize.x, 0 ) );
1687 break;
1688
1690 wxFAIL_MSG( wxT( "Indeterminate state legal only in dialogs." ) );
1691 break;
1692 }
1693
1694 switch( GetVerticalJustify() )
1695 {
1697 break;
1698
1700 Translate( VECTOR2D( 0, -textSize.y / 2.0 ) );
1701 overbarHeight = 0;
1702 break;
1703
1705 Translate( VECTOR2D( 0, -textSize.y ) );
1706 overbarHeight = -textSize.y / 2.0;
1707 break;
1708
1710 wxFAIL_MSG( wxT( "Indeterminate state legal only in dialogs." ) );
1711 break;
1712 }
1713
1714 int overbarLength = 0;
1715 int overbarDepth = -1;
1716 int braceNesting = 0;
1717
1718 auto iterateString =
1719 [&]( const std::function<void( int aOverbarLength, int aOverbarHeight )>& overbarFn,
1720 const std::function<int( unsigned long aChar )>& bitmapCharFn )
1721 {
1722 for( UTF8::uni_iter chIt = text.ubegin(), end = text.uend(); chIt < end; ++chIt )
1723 {
1724 wxASSERT_MSG( *chIt != '\n' && *chIt != '\r',
1725 "No support for multiline bitmap text yet" );
1726
1727 if( *chIt == '~' && overbarDepth == -1 )
1728 {
1729 UTF8::uni_iter lookahead = chIt;
1730
1731 if( ++lookahead != end && *lookahead == '{' )
1732 {
1733 chIt = lookahead;
1734 overbarDepth = braceNesting;
1735 braceNesting++;
1736 continue;
1737 }
1738 }
1739 else if( *chIt == '{' )
1740 {
1741 braceNesting++;
1742 }
1743 else if( *chIt == '}' )
1744 {
1745 if( braceNesting > 0 )
1746 braceNesting--;
1747
1748 if( braceNesting == overbarDepth )
1749 {
1750 overbarFn( overbarLength, overbarHeight );
1751 overbarLength = 0;
1752
1753 overbarDepth = -1;
1754 continue;
1755 }
1756 }
1757
1758 if( overbarDepth != -1 )
1759 overbarLength += bitmapCharFn( *chIt );
1760 else
1761 bitmapCharFn( *chIt );
1762 }
1763 };
1764
1765 // First, calculate the amount of characters and overbars to reserve
1766
1767 int charsCount = 0;
1768 int overbarsCount = 0;
1769
1770 iterateString(
1771 [&overbarsCount]( int aOverbarLength, int aOverbarHeight )
1772 {
1773 overbarsCount++;
1774 },
1775 [&charsCount]( unsigned long aChar ) -> int
1776 {
1777 if( aChar != ' ' )
1778 charsCount++;
1779
1780 return 0;
1781 } );
1782
1783 m_currentManager->Reserve( 6 * charsCount + 6 * overbarsCount );
1784
1785 // Now reset the state and actually draw the characters and overbars
1786 overbarLength = 0;
1787 overbarDepth = -1;
1788 braceNesting = 0;
1789
1790 iterateString(
1791 [&]( int aOverbarLength, int aOverbarHeight )
1792 {
1793 drawBitmapOverbar( aOverbarLength, aOverbarHeight, false );
1794 },
1795 [&]( unsigned long aChar ) -> int
1796 {
1797 return drawBitmapChar( aChar, false );
1798 } );
1799
1800 // Handle the case when overbar is active till the end of the drawn text
1801 m_currentManager->Translate( 0, commonOffset, 0 );
1802
1803 if( overbarDepth != -1 && overbarLength > 0 )
1804 drawBitmapOverbar( overbarLength, overbarHeight );
1805
1806 Restore();
1807}
1808
1809
1811{
1813 m_compositor->SetBuffer( m_mainBuffer );
1814
1815 m_nonCachedManager->EnableDepthTest( false );
1816
1817 // sub-pixel lines all render the same
1818 float minorLineWidth = std::fmax( 1.0f,
1820 float majorLineWidth = minorLineWidth * 2.0f;
1821
1822 // Draw the axis and grid
1823 // For the drawing the start points, end points and increments have
1824 // to be calculated in world coordinates
1825 VECTOR2D worldStartPoint = m_screenWorldMatrix * VECTOR2D( 0.0, 0.0 );
1827
1828 // Draw axes if desired
1829 if( m_axesEnabled )
1830 {
1831 SetLineWidth( minorLineWidth );
1833
1834 DrawLine( VECTOR2D( worldStartPoint.x, 0 ), VECTOR2D( worldEndPoint.x, 0 ) );
1835 DrawLine( VECTOR2D( 0, worldStartPoint.y ), VECTOR2D( 0, worldEndPoint.y ) );
1836 }
1837
1838 // force flush
1839 m_nonCachedManager->EndDrawing();
1840
1841 if( !m_gridVisibility || m_gridSize.x == 0 || m_gridSize.y == 0 )
1842 return;
1843
1844 VECTOR2D gridScreenSize = GetVisibleGridSize();
1845
1846 // Compute grid starting and ending indexes to draw grid points on the
1847 // visible screen area
1848 // Note: later any point coordinate will be offset by m_gridOrigin
1849 int gridStartX = KiROUND( ( worldStartPoint.x - m_gridOrigin.x ) / gridScreenSize.x );
1850 int gridEndX = KiROUND( ( worldEndPoint.x - m_gridOrigin.x ) / gridScreenSize.x );
1851 int gridStartY = KiROUND( ( worldStartPoint.y - m_gridOrigin.y ) / gridScreenSize.y );
1852 int gridEndY = KiROUND( ( worldEndPoint.y - m_gridOrigin.y ) / gridScreenSize.y );
1853
1854 // Ensure start coordinate < end coordinate
1855 normalize( gridStartX, gridEndX );
1856 normalize( gridStartY, gridEndY );
1857
1858 // Ensure the grid fills the screen
1859 --gridStartX;
1860 ++gridEndX;
1861 --gridStartY;
1862 ++gridEndY;
1863
1864 glDisable( GL_DEPTH_TEST );
1865 glDisable( GL_TEXTURE_2D );
1866
1868 {
1869 glEnable( GL_STENCIL_TEST );
1870 glStencilFunc( GL_ALWAYS, 1, 1 );
1871 glStencilOp( GL_KEEP, GL_KEEP, GL_INCR );
1872 glColor4d( 0.0, 0.0, 0.0, 0.0 );
1873 SetStrokeColor( COLOR4D( 0.0, 0.0, 0.0, 0.0 ) );
1874 }
1875 else
1876 {
1877 glColor4d( m_gridColor.r, m_gridColor.g, m_gridColor.b, m_gridColor.a );
1879 }
1880
1882 {
1883 // Vertical positions
1884 for( int j = gridStartY; j <= gridEndY; j++ )
1885 {
1886 bool tickY = ( j % m_gridTick == 0 );
1887 const double posY = j * gridScreenSize.y + m_gridOrigin.y;
1888
1889 // Horizontal positions
1890 for( int i = gridStartX; i <= gridEndX; i++ )
1891 {
1892 bool tickX = ( i % m_gridTick == 0 );
1893 SetLineWidth( ( ( tickX && tickY ) ? majorLineWidth : minorLineWidth ) );
1894 auto lineLen = 2.0 * GetLineWidth();
1895 auto posX = i * gridScreenSize.x + m_gridOrigin.x;
1896
1897 DrawLine( VECTOR2D( posX - lineLen, posY ), VECTOR2D( posX + lineLen, posY ) );
1898 DrawLine( VECTOR2D( posX, posY - lineLen ), VECTOR2D( posX, posY + lineLen ) );
1899 }
1900 }
1901
1902 m_nonCachedManager->EndDrawing();
1903 }
1904 else
1905 {
1906 // Vertical lines
1907 for( int j = gridStartY; j <= gridEndY; j++ )
1908 {
1909 const double y = j * gridScreenSize.y + m_gridOrigin.y;
1910
1911 // If axes are drawn, skip the lines that would cover them
1912 if( m_axesEnabled && y == 0.0 )
1913 continue;
1914
1915 SetLineWidth( ( j % m_gridTick == 0 ) ? majorLineWidth : minorLineWidth );
1916 VECTOR2D a( gridStartX * gridScreenSize.x + m_gridOrigin.x, y );
1917 VECTOR2D b( gridEndX * gridScreenSize.x + m_gridOrigin.x, y );
1918
1919 DrawLine( a, b );
1920 }
1921
1922 m_nonCachedManager->EndDrawing();
1923
1925 {
1926 glStencilFunc( GL_NOTEQUAL, 0, 1 );
1927 glColor4d( m_gridColor.r, m_gridColor.g, m_gridColor.b, m_gridColor.a );
1929 }
1930
1931 // Horizontal lines
1932 for( int i = gridStartX; i <= gridEndX; i++ )
1933 {
1934 const double x = i * gridScreenSize.x + m_gridOrigin.x;
1935
1936 // If axes are drawn, skip the lines that would cover them
1937 if( m_axesEnabled && x == 0.0 )
1938 continue;
1939
1940 SetLineWidth( ( i % m_gridTick == 0 ) ? majorLineWidth : minorLineWidth );
1941 VECTOR2D a( x, gridStartY * gridScreenSize.y + m_gridOrigin.y );
1942 VECTOR2D b( x, gridEndY * gridScreenSize.y + m_gridOrigin.y );
1943 DrawLine( a, b );
1944 }
1945
1946 m_nonCachedManager->EndDrawing();
1947
1949 glDisable( GL_STENCIL_TEST );
1950 }
1951
1952 m_nonCachedManager->EnableDepthTest( true );
1953 glEnable( GL_DEPTH_TEST );
1954 glEnable( GL_TEXTURE_2D );
1955}
1956
1957
1958void OPENGL_GAL::ResizeScreen( int aWidth, int aHeight )
1959{
1960 m_screenSize = VECTOR2I( aWidth, aHeight );
1961
1962 // Resize framebuffers
1963 const float scaleFactor = GetScaleFactor();
1964 m_compositor->Resize( aWidth * scaleFactor, aHeight * scaleFactor );
1966
1967 wxGLCanvas::SetSize( aWidth, aHeight );
1968}
1969
1970
1971bool OPENGL_GAL::Show( bool aShow )
1972{
1973 bool s = wxGLCanvas::Show( aShow );
1974
1975 if( aShow )
1976 wxGLCanvas::Raise();
1977
1978 return s;
1979}
1980
1981
1983{
1984 glFlush();
1985}
1986
1987
1989{
1990 // Clear screen
1992
1993 // NOTE: Black used here instead of m_clearColor; it will be composited later
1994 glClearColor( 0, 0, 0, 1 );
1995 glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT );
1996}
1997
1998
1999void OPENGL_GAL::Transform( const MATRIX3x3D& aTransformation )
2000{
2001 GLdouble matrixData[16] = { 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1 };
2002
2003 matrixData[0] = aTransformation.m_data[0][0];
2004 matrixData[1] = aTransformation.m_data[1][0];
2005 matrixData[2] = aTransformation.m_data[2][0];
2006 matrixData[4] = aTransformation.m_data[0][1];
2007 matrixData[5] = aTransformation.m_data[1][1];
2008 matrixData[6] = aTransformation.m_data[2][1];
2009 matrixData[12] = aTransformation.m_data[0][2];
2010 matrixData[13] = aTransformation.m_data[1][2];
2011 matrixData[14] = aTransformation.m_data[2][2];
2012
2013 glMultMatrixd( matrixData );
2014}
2015
2016
2017void OPENGL_GAL::Rotate( double aAngle )
2018{
2019 m_currentManager->Rotate( aAngle, 0.0f, 0.0f, 1.0f );
2020}
2021
2022
2023void OPENGL_GAL::Translate( const VECTOR2D& aVector )
2024{
2025 m_currentManager->Translate( aVector.x, aVector.y, 0.0f );
2026}
2027
2028
2029void OPENGL_GAL::Scale( const VECTOR2D& aScale )
2030{
2031 m_currentManager->Scale( aScale.x, aScale.y, 1.0f );
2032}
2033
2034
2036{
2037 m_currentManager->PushMatrix();
2038}
2039
2040
2042{
2043 m_currentManager->PopMatrix();
2044}
2045
2046
2048{
2049 m_isGrouping = true;
2050
2051 std::shared_ptr<VERTEX_ITEM> newItem = std::make_shared<VERTEX_ITEM>( *m_cachedManager );
2052 int groupNumber = getNewGroupNumber();
2053 m_groups.insert( std::make_pair( groupNumber, newItem ) );
2054
2055 return groupNumber;
2056}
2057
2058
2060{
2061 m_cachedManager->FinishItem();
2062 m_isGrouping = false;
2063}
2064
2065
2066void OPENGL_GAL::DrawGroup( int aGroupNumber )
2067{
2068 auto group = m_groups.find( aGroupNumber );
2069
2070 if( group != m_groups.end() )
2071 m_cachedManager->DrawItem( *group->second );
2072}
2073
2074
2075void OPENGL_GAL::ChangeGroupColor( int aGroupNumber, const COLOR4D& aNewColor )
2076{
2077 auto group = m_groups.find( aGroupNumber );
2078
2079 if( group != m_groups.end() )
2080 m_cachedManager->ChangeItemColor( *group->second, aNewColor );
2081}
2082
2083
2084void OPENGL_GAL::ChangeGroupDepth( int aGroupNumber, int aDepth )
2085{
2086 auto group = m_groups.find( aGroupNumber );
2087
2088 if( group != m_groups.end() )
2089 m_cachedManager->ChangeItemDepth( *group->second, aDepth );
2090}
2091
2092
2093void OPENGL_GAL::DeleteGroup( int aGroupNumber )
2094{
2095 // Frees memory in the container as well
2096 m_groups.erase( aGroupNumber );
2097}
2098
2099
2101{
2102 m_bitmapCache = std::make_unique<GL_BITMAP_CACHE>();
2103
2104 m_groups.clear();
2105
2106 if( m_isInitialized )
2107 m_cachedManager->Clear();
2108}
2109
2110
2112{
2113 switch( aTarget )
2114 {
2115 default:
2120 }
2121
2122 m_currentTarget = aTarget;
2123}
2124
2125
2127{
2128 return m_currentTarget;
2129}
2130
2131
2133{
2134 // Save the current state
2135 unsigned int oldTarget = m_compositor->GetBuffer();
2136
2137 switch( aTarget )
2138 {
2139 // Cached and noncached items are rendered to the same buffer
2140 default:
2141 case TARGET_CACHED:
2142 case TARGET_NONCACHED:
2143 m_compositor->SetBuffer( m_mainBuffer );
2144 break;
2145
2146 case TARGET_TEMP:
2147 if( m_tempBuffer )
2148 m_compositor->SetBuffer( m_tempBuffer );
2149 break;
2150
2151 case TARGET_OVERLAY:
2152 if( m_overlayBuffer )
2153 m_compositor->SetBuffer( m_overlayBuffer );
2154 break;
2155 }
2156
2157 if( aTarget != TARGET_OVERLAY )
2158 m_compositor->ClearBuffer( m_clearColor );
2159 else if( m_overlayBuffer )
2160 m_compositor->ClearBuffer( COLOR4D::BLACK );
2161
2162 // Restore the previous state
2163 m_compositor->SetBuffer( oldTarget );
2164}
2165
2166
2168{
2169 switch( aTarget )
2170 {
2171 default:
2172 case TARGET_CACHED:
2173 case TARGET_NONCACHED: return true;
2174 case TARGET_OVERLAY: return ( m_overlayBuffer != 0 );
2175 case TARGET_TEMP: return ( m_tempBuffer != 0 );
2176 }
2177}
2178
2179
2181{
2182 wxLogTrace( traceGalXorMode, wxT( "OPENGL_GAL::StartDiffLayer() called" ) );
2183 wxLogTrace( traceGalXorMode, wxT( "StartDiffLayer(): m_tempBuffer=%u" ), m_tempBuffer );
2184
2185 m_currentManager->EndDrawing();
2186
2187 if( m_tempBuffer )
2188 {
2189 wxLogTrace( traceGalXorMode, wxT( "StartDiffLayer(): setting target to TARGET_TEMP" ) );
2192
2193 // ClearTarget restores the previous compositor buffer, so we need to explicitly
2194 // set the compositor to render to m_tempBuffer for the layer drawing
2195 m_compositor->SetBuffer( m_tempBuffer );
2196 wxLogTrace( traceGalXorMode, wxT( "StartDiffLayer(): TARGET_TEMP set and cleared, compositor buffer=%u" ),
2197 m_tempBuffer );
2198 }
2199 else
2200 {
2201 wxLogTrace( traceGalXorMode, wxT( "StartDiffLayer(): WARNING - no temp buffer!" ) );
2202 }
2203}
2204
2205
2207{
2208 wxLogTrace( traceGalXorMode, wxT( "OPENGL_GAL::EndDiffLayer() called" ) );
2209 wxLogTrace( traceGalXorMode, wxT( "EndDiffLayer(): m_tempBuffer=%u, m_mainBuffer=%u" ),
2211
2212 if( m_tempBuffer )
2213 {
2214 wxLogTrace( traceGalXorMode, wxT( "EndDiffLayer(): using temp buffer path" ) );
2215
2216 // End drawing to the temp buffer
2217 m_currentManager->EndDrawing();
2218
2219 wxLogTrace( traceGalXorMode, wxT( "EndDiffLayer(): calling DrawBufferDifference" ) );
2220
2221 // Use difference compositing for true XOR/difference mode:
2222 // - Where only one layer has content: shows that layer's color
2223 // - Where both layers overlap with identical content: cancels out (black)
2224 // - Where layers overlap with different content: shows the absolute difference
2225 m_compositor->DrawBufferDifference( m_tempBuffer, m_mainBuffer );
2226
2227 wxLogTrace( traceGalXorMode, wxT( "EndDiffLayer(): DrawBufferDifference returned" ) );
2228 }
2229 else
2230 {
2231 wxLogTrace( traceGalXorMode, wxT( "EndDiffLayer(): NO temp buffer, using fallback path" ) );
2232
2233 // Fall back to imperfect alpha blending on single buffer
2234 glBlendFunc( GL_SRC_ALPHA, GL_ONE );
2235 m_currentManager->EndDrawing();
2236 glBlendFunc( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA );
2237 }
2238
2239 wxLogTrace( traceGalXorMode, wxT( "OPENGL_GAL::EndDiffLayer() complete" ) );
2240}
2241
2242
2243bool OPENGL_GAL::SetNativeCursorStyle( KICURSOR aCursor, bool aHiDPI )
2244{
2245 // Store the current cursor type and get the wx cursor for it
2246 if( !GAL::SetNativeCursorStyle( aCursor, aHiDPI ) )
2247 return false;
2248
2250
2251#if wxCHECK_VERSION( 3, 3, 0 )
2252 wxWindow::SetCursorBundle( m_currentwxCursor );
2253#else
2254 wxWindow::SetCursor( m_currentwxCursor );
2255#endif
2256
2257 return true;
2258}
2259
2260
2261void OPENGL_GAL::onSetNativeCursor( wxSetCursorEvent& aEvent )
2262{
2263#if wxCHECK_VERSION( 3, 3, 0 )
2264 aEvent.SetCursor( m_currentwxCursor.GetCursorFor( this ) );
2265#else
2266 aEvent.SetCursor( m_currentwxCursor );
2267#endif
2268}
2269
2270
2271void OPENGL_GAL::DrawCursor( const VECTOR2D& aCursorPosition )
2272{
2273 // Now we should only store the position of the mouse cursor
2274 // The real drawing routines are in blitCursor()
2275 //VECTOR2D screenCursor = m_worldScreenMatrix * aCursorPosition;
2276 //m_cursorPosition = m_screenWorldMatrix * VECTOR2D( screenCursor.x, screenCursor.y );
2277 m_cursorPosition = aCursorPosition;
2278}
2279
2280
2281void OPENGL_GAL::drawLineQuad( const VECTOR2D& aStartPoint, const VECTOR2D& aEndPoint,
2282 const bool aReserve )
2283{
2284 /* Helper drawing: ____--- v3 ^
2285 * ____---- ... \ \
2286 * ____---- ... \ end \
2287 * v1 ____---- ... ____---- \ width
2288 * ---- ...___---- \ \
2289 * \ ___...-- \ v
2290 * \ ____----... ____---- v2
2291 * ---- ... ____----
2292 * start \ ... ____----
2293 * \... ____----
2294 * ----
2295 * v0
2296 * dots mark triangles' hypotenuses
2297 */
2298
2299 auto v1 = m_currentManager->GetTransformation()
2300 * glm::vec4( aStartPoint.x, aStartPoint.y, 0.0, 0.0 );
2301 auto v2 = m_currentManager->GetTransformation()
2302 * glm::vec4( aEndPoint.x, aEndPoint.y, 0.0, 0.0 );
2303
2304 VECTOR2D vs( v2.x - v1.x, v2.y - v1.y );
2305
2306 if( aReserve )
2307 reserveLineQuads( 1 );
2308
2309 // Line width is maintained by the vertex shader
2310 m_currentManager->Shader( SHADER_LINE_A, m_lineWidth, vs.x, vs.y );
2311 m_currentManager->Vertex( aStartPoint, m_layerDepth );
2312
2313 m_currentManager->Shader( SHADER_LINE_B, m_lineWidth, vs.x, vs.y );
2314 m_currentManager->Vertex( aStartPoint, m_layerDepth );
2315
2316 m_currentManager->Shader( SHADER_LINE_C, m_lineWidth, vs.x, vs.y );
2317 m_currentManager->Vertex( aEndPoint, m_layerDepth );
2318
2319 m_currentManager->Shader( SHADER_LINE_D, m_lineWidth, vs.x, vs.y );
2320 m_currentManager->Vertex( aEndPoint, m_layerDepth );
2321
2322 m_currentManager->Shader( SHADER_LINE_E, m_lineWidth, vs.x, vs.y );
2323 m_currentManager->Vertex( aEndPoint, m_layerDepth );
2324
2325 m_currentManager->Shader( SHADER_LINE_F, m_lineWidth, vs.x, vs.y );
2326 m_currentManager->Vertex( aStartPoint, m_layerDepth );
2327}
2328
2329
2330void OPENGL_GAL::reserveLineQuads( const int aLineCount )
2331{
2332 m_currentManager->Reserve( 6 * aLineCount );
2333}
2334
2335
2336void OPENGL_GAL::drawSemiCircle( const VECTOR2D& aCenterPoint, double aRadius, double aAngle )
2337{
2338 if( m_isFillEnabled )
2339 {
2341 drawFilledSemiCircle( aCenterPoint, aRadius, aAngle );
2342 }
2343
2344 if( m_isStrokeEnabled )
2345 {
2347 m_strokeColor.a );
2348 drawStrokedSemiCircle( aCenterPoint, aRadius, aAngle );
2349 }
2350}
2351
2352
2353void OPENGL_GAL::drawFilledSemiCircle( const VECTOR2D& aCenterPoint, double aRadius, double aAngle )
2354{
2355 Save();
2356
2357 m_currentManager->Reserve( 3 );
2358 m_currentManager->Translate( aCenterPoint.x, aCenterPoint.y, 0.0f );
2359 m_currentManager->Rotate( aAngle, 0.0f, 0.0f, 1.0f );
2360
2361 /* Draw a triangle that contains the semicircle, then shade it to leave only
2362 * the semicircle. Parameters given to Shader() are indices of the triangle's vertices
2363 * (if you want to understand more, check the vertex shader source [shader.vert]).
2364 * Shader uses these coordinates to determine if fragments are inside the semicircle or not.
2365 * v2
2366 * /\
2367 * /__\
2368 * v0 //__\\ v1
2369 */
2370 m_currentManager->Shader( SHADER_FILLED_CIRCLE, 4.0f );
2371 m_currentManager->Vertex( -aRadius * 3.0f / sqrt( 3.0f ), 0.0f, m_layerDepth ); // v0
2372
2373 m_currentManager->Shader( SHADER_FILLED_CIRCLE, 5.0f );
2374 m_currentManager->Vertex( aRadius * 3.0f / sqrt( 3.0f ), 0.0f, m_layerDepth ); // v1
2375
2376 m_currentManager->Shader( SHADER_FILLED_CIRCLE, 6.0f );
2377 m_currentManager->Vertex( 0.0f, aRadius * 2.0f, m_layerDepth ); // v2
2378
2379 Restore();
2380}
2381
2382
2383void OPENGL_GAL::drawStrokedSemiCircle( const VECTOR2D& aCenterPoint, double aRadius, double aAngle,
2384 bool aReserve )
2385{
2386 double outerRadius = aRadius + ( m_lineWidth / 2 );
2387
2388 Save();
2389
2390 if( aReserve )
2391 m_currentManager->Reserve( 3 );
2392
2393 m_currentManager->Translate( aCenterPoint.x, aCenterPoint.y, 0.0f );
2394 m_currentManager->Rotate( aAngle, 0.0f, 0.0f, 1.0f );
2395
2396 /* Draw a triangle that contains the semicircle, then shade it to leave only
2397 * the semicircle. Parameters given to Shader() are indices of the triangle's vertices
2398 * (if you want to understand more, check the vertex shader source [shader.vert]), the
2399 * radius and the line width. Shader uses these coordinates to determine if fragments are
2400 * inside the semicircle or not.
2401 * v2
2402 * /\
2403 * /__\
2404 * v0 //__\\ v1
2405 */
2406 m_currentManager->Shader( SHADER_STROKED_CIRCLE, 4.0f, aRadius, m_lineWidth );
2407 m_currentManager->Vertex( -outerRadius * 3.0f / sqrt( 3.0f ), 0.0f, m_layerDepth ); // v0
2408
2409 m_currentManager->Shader( SHADER_STROKED_CIRCLE, 5.0f, aRadius, m_lineWidth );
2410 m_currentManager->Vertex( outerRadius * 3.0f / sqrt( 3.0f ), 0.0f, m_layerDepth ); // v1
2411
2412 m_currentManager->Shader( SHADER_STROKED_CIRCLE, 6.0f, aRadius, m_lineWidth );
2413 m_currentManager->Vertex( 0.0f, outerRadius * 2.0f, m_layerDepth ); // v2
2414
2415 Restore();
2416}
2417
2418
2419void OPENGL_GAL::drawPolygon( GLdouble* aPoints, int aPointCount )
2420{
2421 if( m_isFillEnabled )
2422 {
2423 m_currentManager->Shader( SHADER_NONE );
2425
2426 // Any non convex polygon needs to be tesselated
2427 // for this purpose the GLU standard functions are used
2429 gluTessBeginPolygon( m_tesselator, &params );
2430 gluTessBeginContour( m_tesselator );
2431
2432 GLdouble* point = aPoints;
2433
2434 for( int i = 0; i < aPointCount; ++i )
2435 {
2436 gluTessVertex( m_tesselator, point, point );
2437 point += 3; // 3 coordinates
2438 }
2439
2440 gluTessEndContour( m_tesselator );
2441 gluTessEndPolygon( m_tesselator );
2442
2443 // Free allocated intersecting points
2444 m_tessIntersects.clear();
2445 }
2446
2447 if( m_isStrokeEnabled )
2448 {
2450 [&]( int idx )
2451 {
2452 return VECTOR2D( aPoints[idx * 3], aPoints[idx * 3 + 1] );
2453 },
2454 aPointCount );
2455 }
2456}
2457
2458
2459void OPENGL_GAL::drawPolyline( const std::function<VECTOR2D( int )>& aPointGetter, int aPointCount,
2460 bool aReserve )
2461{
2462 wxCHECK( aPointCount > 0, /* return */ );
2463
2465
2466 if( aPointCount == 1 )
2467 {
2468 drawLineQuad( aPointGetter( 0 ), aPointGetter( 0 ), aReserve );
2469 return;
2470 }
2471
2472 if( aReserve )
2473 {
2474 reserveLineQuads( aPointCount - 1 );
2475 }
2476
2477 for( int i = 1; i < aPointCount; ++i )
2478 {
2479 auto start = aPointGetter( i - 1 );
2480 auto end = aPointGetter( i );
2481
2482 drawLineQuad( start, end, false );
2483 }
2484}
2485
2486
2487void OPENGL_GAL::drawSegmentChain( const std::function<VECTOR2D( int )>& aPointGetter,
2488 int aPointCount, double aWidth, bool aReserve )
2489{
2490 wxCHECK( aPointCount >= 2, /* return */ );
2491
2493
2494 int vertices = 0;
2495
2496 for( int i = 1; i < aPointCount; ++i )
2497 {
2498 auto start = aPointGetter( i - 1 );
2499 auto end = aPointGetter( i );
2500
2501 float startx = start.x;
2502 float starty = start.y;
2503 float endx = end.x;
2504 float endy = end.y;
2505
2506 // Be careful about floating point rounding. As we draw segments in larger and larger
2507 // coordinates, the shader (which uses floats) will lose precision and stop drawing small
2508 // segments. In this case, we need to draw a circle for the minimal segment.
2509 // Check if the coordinate differences can be accurately represented as floats
2510
2511 if( startx == endx && starty == endy )
2512 {
2513 vertices += 3; // One circle
2514 continue;
2515 }
2516
2517 if( m_isFillEnabled || aWidth == 1.0 )
2518 {
2519 vertices += 6; // One line
2520 }
2521 else
2522 {
2523 vertices += 6 + 6 + 3 + 3; // Two lines and two half-circles
2524 }
2525 }
2526
2527 m_currentManager->Reserve( vertices );
2528
2529 for( int i = 1; i < aPointCount; ++i )
2530 {
2531 auto start = aPointGetter( i - 1 );
2532 auto end = aPointGetter( i );
2533
2534 drawSegment( start, end, aWidth, false );
2535 }
2536}
2537
2538
2539int OPENGL_GAL::drawBitmapChar( unsigned long aChar, bool aReserve )
2540{
2541 const float TEX_X = font_image.width;
2542 const float TEX_Y = font_image.height;
2543
2544 // handle space
2545 if( aChar == ' ' )
2546 {
2547 const FONT_GLYPH_TYPE* g = LookupGlyph( 'x' );
2548 wxCHECK( g, 0 );
2549
2550 // Match stroke font as well as possible
2551 double spaceWidth = g->advance * 0.74;
2552
2553 Translate( VECTOR2D( spaceWidth, 0 ) );
2554 return KiROUND( spaceWidth );
2555 }
2556
2557 const FONT_GLYPH_TYPE* glyph = LookupGlyph( aChar );
2558
2559 // If the glyph is not found (happens for many esoteric unicode chars)
2560 // shows a '?' instead.
2561 if( !glyph )
2562 glyph = LookupGlyph( '?' );
2563
2564 if( !glyph ) // Should not happen.
2565 return 0;
2566
2567 const float X = glyph->atlas_x + font_information.smooth_pixels;
2568 const float Y = glyph->atlas_y + font_information.smooth_pixels;
2569 const float XOFF = glyph->minx;
2570
2571 // adjust for height rounding
2572 const float round_adjust = ( glyph->maxy - glyph->miny )
2573 - float( glyph->atlas_h - font_information.smooth_pixels * 2 );
2574 const float top_adjust = font_information.max_y - glyph->maxy;
2575 const float YOFF = round_adjust + top_adjust;
2576 const float W = glyph->atlas_w - font_information.smooth_pixels * 2;
2577 const float H = glyph->atlas_h - font_information.smooth_pixels * 2;
2578 const float B = 0;
2579
2580 if( aReserve )
2581 m_currentManager->Reserve( 6 );
2582
2583 Translate( VECTOR2D( XOFF, YOFF ) );
2584
2585 /* Glyph:
2586 * v0 v1
2587 * +--+
2588 * | /|
2589 * |/ |
2590 * +--+
2591 * v2 v3
2592 */
2593 m_currentManager->Shader( SHADER_FONT, X / TEX_X, ( Y + H ) / TEX_Y );
2594 m_currentManager->Vertex( -B, -B, 0 ); // v0
2595
2596 m_currentManager->Shader( SHADER_FONT, ( X + W ) / TEX_X, ( Y + H ) / TEX_Y );
2597 m_currentManager->Vertex( W + B, -B, 0 ); // v1
2598
2599 m_currentManager->Shader( SHADER_FONT, X / TEX_X, Y / TEX_Y );
2600 m_currentManager->Vertex( -B, H + B, 0 ); // v2
2601
2602
2603 m_currentManager->Shader( SHADER_FONT, ( X + W ) / TEX_X, ( Y + H ) / TEX_Y );
2604 m_currentManager->Vertex( W + B, -B, 0 ); // v1
2605
2606 m_currentManager->Shader( SHADER_FONT, X / TEX_X, Y / TEX_Y );
2607 m_currentManager->Vertex( -B, H + B, 0 ); // v2
2608
2609 m_currentManager->Shader( SHADER_FONT, ( X + W ) / TEX_X, Y / TEX_Y );
2610 m_currentManager->Vertex( W + B, H + B, 0 ); // v3
2611
2612 Translate( VECTOR2D( -XOFF + glyph->advance, -YOFF ) );
2613
2614 return glyph->advance;
2615}
2616
2617
2618void OPENGL_GAL::drawBitmapOverbar( double aLength, double aHeight, bool aReserve )
2619{
2620 // To draw an overbar, simply draw an overbar
2621 const FONT_GLYPH_TYPE* glyph = LookupGlyph( '_' );
2622 wxCHECK( glyph, /* void */ );
2623
2624 const float H = glyph->maxy - glyph->miny;
2625
2626 Save();
2627
2628 Translate( VECTOR2D( -aLength, -aHeight ) );
2629
2630 if( aReserve )
2631 m_currentManager->Reserve( 6 );
2632
2634
2635 m_currentManager->Shader( 0 );
2636
2637 m_currentManager->Vertex( 0, 0, 0 ); // v0
2638 m_currentManager->Vertex( aLength, 0, 0 ); // v1
2639 m_currentManager->Vertex( 0, H, 0 ); // v2
2640
2641 m_currentManager->Vertex( aLength, 0, 0 ); // v1
2642 m_currentManager->Vertex( 0, H, 0 ); // v2
2643 m_currentManager->Vertex( aLength, H, 0 ); // v3
2644
2645 Restore();
2646}
2647
2648
2649std::pair<VECTOR2D, float> OPENGL_GAL::computeBitmapTextSize( const UTF8& aText ) const
2650{
2651 static const FONT_GLYPH_TYPE* defaultGlyph = LookupGlyph( '(' ); // for strange chars
2652
2653 VECTOR2D textSize( 0, 0 );
2654 float commonOffset = std::numeric_limits<float>::max();
2655 float charHeight = font_information.max_y - defaultGlyph->miny;
2656 int overbarDepth = -1;
2657 int braceNesting = 0;
2658
2659 for( UTF8::uni_iter chIt = aText.ubegin(), end = aText.uend(); chIt < end; ++chIt )
2660 {
2661 if( *chIt == '~' && overbarDepth == -1 )
2662 {
2663 UTF8::uni_iter lookahead = chIt;
2664
2665 if( ++lookahead != end && *lookahead == '{' )
2666 {
2667 chIt = lookahead;
2668 overbarDepth = braceNesting;
2669 braceNesting++;
2670 continue;
2671 }
2672 }
2673 else if( *chIt == '{' )
2674 {
2675 braceNesting++;
2676 }
2677 else if( *chIt == '}' )
2678 {
2679 if( braceNesting > 0 )
2680 braceNesting--;
2681
2682 if( braceNesting == overbarDepth )
2683 {
2684 overbarDepth = -1;
2685 continue;
2686 }
2687 }
2688
2689 const FONT_GLYPH_TYPE* glyph = LookupGlyph( *chIt );
2690
2691 if( !glyph // Not coded in font
2692 || *chIt == '-' || *chIt == '_' ) // Strange size of these 2 chars
2693 {
2694 glyph = defaultGlyph;
2695 }
2696
2697 if( glyph )
2698 textSize.x += glyph->advance;
2699 }
2700
2701 textSize.y = std::max<float>( textSize.y, charHeight );
2702 commonOffset = std::min<float>( font_information.max_y - defaultGlyph->maxy, commonOffset );
2703 textSize.y -= commonOffset;
2704
2705 return std::make_pair( textSize, commonOffset );
2706}
2707
2708
2709void OPENGL_GAL::onPaint( wxPaintEvent& aEvent )
2710{
2711 PostPaint( aEvent );
2712}
2713
2714
2715void OPENGL_GAL::skipMouseEvent( wxMouseEvent& aEvent )
2716{
2717 // Post the mouse event to the event listener registered in constructor, if any
2718 if( m_mouseListener )
2719 wxPostEvent( m_mouseListener, aEvent );
2720}
2721
2722
2723void OPENGL_GAL::skipGestureEvent( wxGestureEvent& aEvent )
2724{
2725 // Post the gesture event to the event listener registered in constructor, if any
2726 if( m_mouseListener )
2727 wxPostEvent( m_mouseListener, aEvent );
2728}
2729
2730
2732{
2733 if( !IsCursorEnabled() )
2734 return;
2735
2737
2738 VECTOR2D cursorBegin;
2739 VECTOR2D cursorEnd;
2740 VECTOR2D cursorCenter = m_cursorPosition;
2741
2743 {
2744 cursorBegin = m_screenWorldMatrix * VECTOR2D( 0.0, 0.0 );
2745 cursorEnd = m_screenWorldMatrix * VECTOR2D( m_screenSize );
2746 }
2748 {
2749 const int cursorSize = 80;
2750 cursorBegin = m_cursorPosition - cursorSize / ( 2 * m_worldScale );
2751 cursorEnd = m_cursorPosition + cursorSize / ( 2 * m_worldScale );
2752 }
2753
2754 const COLOR4D color = getCursorColor();
2755
2756 GLboolean depthTestEnabled = glIsEnabled( GL_DEPTH_TEST );
2757 glDisable( GL_DEPTH_TEST );
2758
2759 glActiveTexture( GL_TEXTURE0 );
2760 glDisable( GL_TEXTURE_2D );
2761 glEnable( GL_BLEND );
2762 glBlendFunc( GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA );
2763
2764 glLineWidth( 1.0 );
2765 glColor4d( color.r, color.g, color.b, color.a );
2766
2767 glMatrixMode( GL_PROJECTION );
2768 glPushMatrix();
2769 glTranslated( 0, 0, -0.5 );
2770
2771 glBegin( GL_LINES );
2772
2774 {
2775 // Calculate screen bounds in world coordinates
2776 VECTOR2D screenTopLeft = m_screenWorldMatrix * VECTOR2D( 0.0, 0.0 );
2777 VECTOR2D screenBottomRight = m_screenWorldMatrix * VECTOR2D( m_screenSize );
2778
2779 // For 45-degree lines passing through cursor position
2780 // Line equation: y = x + (cy - cx) for positive slope
2781 // Line equation: y = -x + (cy + cx) for negative slope
2782 double cx = m_cursorPosition.x;
2783 double cy = m_cursorPosition.y;
2784
2785 // Calculate intersections for positive slope diagonal (y = x + offset)
2786 double offset1 = cy - cx;
2787 VECTOR2D pos_start( screenTopLeft.x, screenTopLeft.x + offset1 );
2788 VECTOR2D pos_end( screenBottomRight.x, screenBottomRight.x + offset1 );
2789
2790 // Draw positive slope diagonal
2791 glVertex2d( pos_start.x, pos_start.y );
2792 glVertex2d( pos_end.x, pos_end.y );
2793
2794 // Calculate intersections for negative slope diagonal (y = -x + offset)
2795 double offset2 = cy + cx;
2796 VECTOR2D neg_start( screenTopLeft.x, offset2 - screenTopLeft.x );
2797 VECTOR2D neg_end( screenBottomRight.x, offset2 - screenBottomRight.x );
2798
2799 // Draw negative slope diagonal
2800 glVertex2d( neg_start.x, neg_start.y );
2801 glVertex2d( neg_end.x, neg_end.y );
2802 }
2803 else
2804 {
2805 glVertex2d( cursorCenter.x, cursorBegin.y );
2806 glVertex2d( cursorCenter.x, cursorEnd.y );
2807
2808 glVertex2d( cursorBegin.x, cursorCenter.y );
2809 glVertex2d( cursorEnd.x, cursorCenter.y );
2810 }
2811
2812 glEnd();
2813
2814 glPopMatrix();
2815
2816 if( depthTestEnabled )
2817 glEnable( GL_DEPTH_TEST );
2818}
2819
2820
2822{
2823 wxASSERT_MSG( m_groups.size() < std::numeric_limits<unsigned int>::max(),
2824 wxT( "There are no free slots to store a group" ) );
2825
2826 while( m_groups.find( m_groupCounter ) != m_groups.end() )
2828
2829 return m_groupCounter++;
2830}
2831
2832
2834{
2835 wxASSERT_MSG( m_isContextLocked, "This should only be called from within a locked context." );
2836
2837 // Check correct initialization from the constructor
2838 if( m_tesselator == nullptr )
2839 throw std::runtime_error( "Could not create the tesselator" );
2840
2842
2843 int glVersion = gladLoaderLoadGL();
2844
2845 if( glVersion == 0 )
2846 throw std::runtime_error( "Failed to load OpenGL via loader" );
2847
2848 const char* vendor = (const char*) glGetString( GL_VENDOR );
2849 const char* renderer = (const char*) glGetString( GL_RENDERER );
2850 const char* version = (const char*) glGetString( GL_VERSION );
2851
2852 if( !version )
2853 throw std::runtime_error( "No GL context is current (glGetString returned NULL)" );
2854
2855 SetOpenGLInfo( vendor, renderer, version );
2856
2857 // Check the OpenGL version (minimum 2.1 is required)
2858 if( !GLAD_GL_VERSION_2_1 )
2859 throw std::runtime_error( "OpenGL 2.1 or higher is required!" );
2860
2861#if defined( __LINUX__ ) // calling enableGlDebug crashes opengl on some OS (OSX and some Windows)
2862#ifdef DEBUG
2863 if( glDebugMessageCallback )
2864 enableGlDebug( true );
2865#endif
2866#endif
2867
2868 // Framebuffers have to be supported
2869 if( !GLAD_GL_ARB_framebuffer_object )
2870 throw std::runtime_error( "Framebuffer objects are not supported!" );
2871
2872 // Vertex buffer has to be supported
2873 if( !GLAD_GL_ARB_vertex_buffer_object )
2874 throw std::runtime_error( "Vertex buffer objects are not supported!" );
2875
2876 // Prepare shaders
2877 if( !m_shader->IsLinked()
2878 && !m_shader->LoadShaderFromStrings( SHADER_TYPE_VERTEX,
2879 BUILTIN_SHADERS::glsl_kicad_vert ) )
2880 {
2881 throw std::runtime_error( "Cannot compile vertex shader!" );
2882 }
2883
2884 if( !m_shader->IsLinked()
2885 && !m_shader->LoadShaderFromStrings( SHADER_TYPE_FRAGMENT,
2886 BUILTIN_SHADERS::glsl_kicad_frag ) )
2887 {
2888 throw std::runtime_error( "Cannot compile fragment shader!" );
2889 }
2890
2891 if( !m_shader->IsLinked() && !m_shader->Link() )
2892 throw std::runtime_error( "Cannot link the shaders!" );
2893
2894 // Set up shader parameters after linking
2896
2897 // Check if video card supports textures big enough to fit the font atlas
2898 int maxTextureSize;
2899 glGetIntegerv( GL_MAX_TEXTURE_SIZE, &maxTextureSize );
2900
2901 if( maxTextureSize < (int) font_image.width || maxTextureSize < (int) font_image.height )
2902 {
2903 // TODO implement software texture scaling
2904 // for bitmap fonts and use a higher resolution texture?
2905 throw std::runtime_error( "Requested texture size is not supported" );
2906 }
2907
2908#if wxCHECK_VERSION( 3, 3, 3 )
2909 wxGLCanvas::SetSwapInterval( -1 );
2910 m_swapInterval = wxGLCanvas::GetSwapInterval();
2911#else
2913#endif
2914
2915 m_cachedManager = new VERTEX_MANAGER( true );
2916 m_nonCachedManager = new VERTEX_MANAGER( false );
2917 m_overlayManager = new VERTEX_MANAGER( false );
2918 m_tempManager = new VERTEX_MANAGER( false );
2919
2920 // Make VBOs use shaders
2921 m_cachedManager->SetShader( *m_shader );
2922 m_nonCachedManager->SetShader( *m_shader );
2923 m_overlayManager->SetShader( *m_shader );
2924 m_tempManager->SetShader( *m_shader );
2925
2926 m_isInitialized = true;
2927}
2928
2929
2931{
2932 // Initialize shader uniform parameter locations
2933 ufm_fontTexture = m_shader->AddParameter( "u_fontTexture" );
2934 ufm_fontTextureWidth = m_shader->AddParameter( "u_fontTextureWidth" );
2935 ufm_worldPixelSize = m_shader->AddParameter( "u_worldPixelSize" );
2936 ufm_screenPixelSize = m_shader->AddParameter( "u_screenPixelSize" );
2937 ufm_pixelSizeMultiplier = m_shader->AddParameter( "u_pixelSizeMultiplier" );
2938 ufm_antialiasingOffset = m_shader->AddParameter( "u_antialiasingOffset" );
2939 ufm_minLinePixelWidth = m_shader->AddParameter( "u_minLinePixelWidth" );
2940}
2941
2942
2943// Callback functions for the tesselator. Compare Redbook Chapter 11.
2944void CALLBACK VertexCallback( GLvoid* aVertexPtr, void* aData )
2945{
2946 GLdouble* vertex = static_cast<GLdouble*>( aVertexPtr );
2947 OPENGL_GAL::TessParams* param = static_cast<OPENGL_GAL::TessParams*>( aData );
2948 VERTEX_MANAGER* vboManager = param->vboManager;
2949
2950 assert( vboManager );
2951 vboManager->Vertex( vertex[0], vertex[1], vertex[2] );
2952}
2953
2954
2955void CALLBACK CombineCallback( GLdouble coords[3], GLdouble* vertex_data[4], GLfloat weight[4],
2956 GLdouble** dataOut, void* aData )
2957{
2958 GLdouble* vertex = new GLdouble[3];
2959 OPENGL_GAL::TessParams* param = static_cast<OPENGL_GAL::TessParams*>( aData );
2960
2961 // Save the pointer so we can delete it later
2962 // Note, we use the default_delete for an array because macOS
2963 // decides to bundle an ancient libc++ that mismatches the C++17 support of clang
2964 param->intersectPoints.emplace_back( vertex, std::default_delete<GLdouble[]>() );
2965
2966 memcpy( vertex, coords, 3 * sizeof( GLdouble ) );
2967
2968 *dataOut = vertex;
2969}
2970
2971
2972void CALLBACK EdgeCallback( GLboolean aEdgeFlag )
2973{
2974 // This callback is needed to force GLU tesselator to use triangles only
2975}
2976
2977
2978void CALLBACK ErrorCallback( GLenum aErrorCode )
2979{
2980 //throw std::runtime_error( std::string( "Tessellation error: " ) +
2981 //std::string( (const char*) gluErrorString( aErrorCode ) );
2982}
2983
2984
2985static void InitTesselatorCallbacks( GLUtesselator* aTesselator )
2986{
2987 gluTessCallback( aTesselator, GLU_TESS_VERTEX_DATA, (void( CALLBACK* )()) VertexCallback );
2988 gluTessCallback( aTesselator, GLU_TESS_COMBINE_DATA, (void( CALLBACK* )()) CombineCallback );
2989 gluTessCallback( aTesselator, GLU_TESS_EDGE_FLAG, (void( CALLBACK* )()) EdgeCallback );
2990 gluTessCallback( aTesselator, GLU_TESS_ERROR, (void( CALLBACK* )()) ErrorCallback );
2991}
2992
2993
2994void OPENGL_GAL::EnableDepthTest( bool aEnabled )
2995{
2996 m_cachedManager->EnableDepthTest( aEnabled );
2997 m_nonCachedManager->EnableDepthTest( aEnabled );
2998 m_overlayManager->EnableDepthTest( aEnabled );
2999}
3000
3001
3002inline double round_to_half_pixel( double f, double r )
3003{
3004 return ( ceil( f / r ) - 0.5 ) * r;
3005}
3006
3007
3009{
3011 auto pixelSize = m_worldScale;
3012
3013 // we need -m_lookAtPoint == -k * pixelSize + 0.5 * pixelSize for OpenGL
3014 // meaning m_lookAtPoint = (k-0.5)*pixelSize with integer k
3017
3019}
3020
3021
3022void OPENGL_GAL::DrawGlyph( const KIFONT::GLYPH& aGlyph, int aNth, int aTotal )
3023{
3024 if( aGlyph.IsStroke() )
3025 {
3026 const auto& strokeGlyph = static_cast<const KIFONT::STROKE_GLYPH&>( aGlyph );
3027
3028 DrawPolylines( strokeGlyph );
3029 }
3030 else if( aGlyph.IsOutline() )
3031 {
3032 const auto& outlineGlyph = static_cast<const KIFONT::OUTLINE_GLYPH&>( aGlyph );
3033
3034 m_currentManager->Shader( SHADER_NONE );
3035 m_currentManager->Color( m_fillColor );
3036
3037 outlineGlyph.Triangulate(
3038 [&]( const VECTOR2D& aPt1, const VECTOR2D& aPt2, const VECTOR2D& aPt3 )
3039 {
3040 m_currentManager->Reserve( 3 );
3041
3042 m_currentManager->Vertex( aPt1.x, aPt1.y, m_layerDepth );
3043 m_currentManager->Vertex( aPt2.x, aPt2.y, m_layerDepth );
3044 m_currentManager->Vertex( aPt3.x, aPt3.y, m_layerDepth );
3045 } );
3046 }
3047}
3048
3049
3050void OPENGL_GAL::DrawGlyphs( const std::vector<std::unique_ptr<KIFONT::GLYPH>>& aGlyphs )
3051{
3052 if( aGlyphs.empty() )
3053 return;
3054
3055 bool allGlyphsAreStroke = true;
3056 bool allGlyphsAreOutline = true;
3057
3058 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aGlyphs )
3059 {
3060 if( !glyph->IsStroke() )
3061 {
3062 allGlyphsAreStroke = false;
3063 break;
3064 }
3065 }
3066
3067 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aGlyphs )
3068 {
3069 if( !glyph->IsOutline() )
3070 {
3071 allGlyphsAreOutline = false;
3072 break;
3073 }
3074 }
3075
3076 if( allGlyphsAreStroke )
3077 {
3078 // Optimized path for stroke fonts that pre-reserves line quads.
3079 int lineQuadCount = 0;
3080
3081 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aGlyphs )
3082 {
3083 const auto& strokeGlyph = static_cast<const KIFONT::STROKE_GLYPH&>( *glyph );
3084
3085 for( const std::vector<VECTOR2D>& points : strokeGlyph )
3086 lineQuadCount += points.size() - 1;
3087 }
3088
3089 reserveLineQuads( lineQuadCount );
3090
3091 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aGlyphs )
3092 {
3093 const auto& strokeGlyph = static_cast<const KIFONT::STROKE_GLYPH&>( *glyph );
3094
3095 for( const std::vector<VECTOR2D>& points : strokeGlyph )
3096 {
3098 [&]( int idx )
3099 {
3100 return points[idx];
3101 },
3102 points.size(), false );
3103 }
3104 }
3105
3106 return;
3107 }
3108 else if( allGlyphsAreOutline )
3109 {
3110 // Optimized path for outline fonts that pre-reserves glyph triangles.
3111 int triangleCount = 0;
3112
3113 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aGlyphs )
3114 {
3115 const auto& outlineGlyph = static_cast<const KIFONT::OUTLINE_GLYPH&>( *glyph );
3116
3117 for( unsigned int i = 0; i < outlineGlyph.TriangulatedPolyCount(); i++ )
3118 {
3120 outlineGlyph.TriangulatedPolygon( i );
3121
3122 triangleCount += polygon->GetTriangleCount();
3123 }
3124 }
3125
3126 m_currentManager->Shader( SHADER_NONE );
3127 m_currentManager->Color( m_fillColor );
3128
3129 m_currentManager->Reserve( 3 * triangleCount );
3130
3131 for( const std::unique_ptr<KIFONT::GLYPH>& glyph : aGlyphs )
3132 {
3133 const auto& outlineGlyph = static_cast<const KIFONT::OUTLINE_GLYPH&>( *glyph );
3134
3135 for( unsigned int i = 0; i < outlineGlyph.TriangulatedPolyCount(); i++ )
3136 {
3138 outlineGlyph.TriangulatedPolygon( i );
3139
3140 for( size_t j = 0; j < polygon->GetTriangleCount(); j++ )
3141 {
3142 VECTOR2I a, b, c;
3143 polygon->GetTriangle( j, a, b, c );
3144
3145 m_currentManager->Vertex( a.x, a.y, m_layerDepth );
3146 m_currentManager->Vertex( b.x, b.y, m_layerDepth );
3147 m_currentManager->Vertex( c.x, c.y, m_layerDepth );
3148 }
3149 }
3150 }
3151 }
3152 else
3153 {
3154 // Regular path
3155 for( size_t i = 0; i < aGlyphs.size(); i++ )
3156 DrawGlyph( *aGlyphs[i], i, aGlyphs.size() );
3157 }
3158}
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition box2.h:990
void SetOpenGLInfo(const char *aVendor, const char *aRenderer, const char *aVersion)
A setter for OpenGL info when it's initialized.
void SetOpenGLBackendInfo(wxString aBackend)
A setter for OpenGL backend info after the canvas is created.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
Bezier curves to polygon converter.
void GetPoly(std::vector< VECTOR2I > &aOutput, int aMaxError=10)
Convert a Bezier curve to a polygon.
This class handle bitmap images in KiCad.
Definition bitmap_base.h:49
const wxImage * GetOriginalImageData() const
Definition bitmap_base.h:71
VECTOR2I GetSizePixels() const
EDA_ANGLE Rotation() const
bool IsMirroredX() const
bool IsMirroredY() const
KIID GetImageID() const
Definition bitmap_base.h:76
int GetPPI() const
static const WX_CURSOR_TYPE GetCursor(KICURSOR aCursorType, bool aHiDPI=false)
Get a cursor bundle (wx 3.3+) or appropriate cursor (older versions)
Definition cursors.cpp:403
double AsDegrees() const
Definition eda_angle.h:116
double AsRadians() const
Definition eda_angle.h:120
void UnlockCtx(wxGLContext *aContext)
Allow other canvases to bind an OpenGL context.
void DestroyCtx(wxGLContext *aContext)
Destroy a managed OpenGL context.
void LockCtx(wxGLContext *aContext, wxGLCanvas *aCanvas)
Set a context as current and prevents other canvases from switching it.
wxGLContext * CreateCtx(wxGLCanvas *aCanvas, const wxGLContext *aOther=nullptr)
Create a managed OpenGL context.
static int SetSwapInterval(wxGLCanvas *aCanvas, int aVal)
Attempt to set the OpenGL swap interval.
Definition gl_utils.cpp:82
static wxString DetectGLBackend(wxGLCanvas *aCanvas)
Definition gl_utils.cpp:54
HIDPI_GL_CANVAS(const KIGFX::VC_SETTINGS &aSettings, wxWindow *aParent, const wxGLAttributes &aGLAttribs, wxWindowID aId=wxID_ANY, const wxPoint &aPos=wxDefaultPosition, const wxSize &aSize=wxDefaultSize, long aStyle=0, const wxString &aName=wxGLCanvasName, const wxPalette &aPalette=wxNullPalette)
virtual wxSize GetNativePixelSize() const
double GetScaleFactor() const
Get the current scale factor.
virtual bool IsStroke() const
Definition glyph.h:51
virtual bool IsOutline() const
Definition glyph.h:50
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:105
double r
Red component.
Definition color4d.h:393
double g
Green component.
Definition color4d.h:394
double a
Alpha component.
Definition color4d.h:396
static const COLOR4D BLACK
Definition color4d.h:406
double b
Blue component.
Definition color4d.h:395
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
virtual void SetLayerDepth(double aLayerDepth)
Set the depth of the layer (position on the z-axis)
bool IsCursorEnabled() const
Return information about cursor visibility.
friend class GAL_CONTEXT_LOCKER
MATRIX3x3D m_worldScreenMatrix
World transformation.
VECTOR2D GetVisibleGridSize() const
Return the visible grid size in x and y directions.
double m_layerDepth
The actual layer depth.
MATRIX3x3D m_screenWorldMatrix
Screen transformation.
bool m_axesEnabled
Should the axes be drawn.
float m_gridLineWidth
Line width of the grid.
VECTOR2I m_screenSize
Screen size in screen (wx logical) coordinates.
GR_TEXT_H_ALIGN_T GetHorizontalJustify() const
void normalize(T &a, T &b)
Ensure that the first element is smaller than the second.
VECTOR2D m_depthRange
Range of the depth.
virtual void SetFillColor(const COLOR4D &aColor)
Set the fill color.
virtual bool SetNativeCursorStyle(KICURSOR aCursor, bool aHiDPI)
Set the cursor in the native panel.
GRID_STYLE m_gridStyle
Grid display style.
COLOR4D m_axesColor
Color of the axes.
const MATRIX3x3D & GetScreenWorldMatrix() const
Get the screen <-> world transformation matrix.
float m_lineWidth
The line width.
void computeWorldScale()
Compute the scaling factor for the world->screen matrix.
virtual void SetLineWidth(float aLineWidth)
Set the line width.
VECTOR2D m_gridSize
The grid size.
COLOR4D getCursorColor() const
Get the actual cursor color to draw.
COLOR4D m_fillColor
The fill color.
double m_worldUnitLength
The unit length of the world coordinates [inch].
virtual bool updatedGalDisplayOptions(const GAL_DISPLAY_OPTIONS &aOptions)
Handle updating display options.
void SetAxesColor(const COLOR4D &aAxesColor)
Set the axes color.
virtual void SetStrokeColor(const COLOR4D &aColor)
Set the stroke color.
VECTOR2D m_cursorPosition
Current cursor position (world coordinates)
const VECTOR2I & GetGlyphSize() const
int m_gridTick
Every tick line gets the double width.
double m_worldScale
The scale factor world->screen.
VECTOR2D m_gridOrigin
The grid origin.
virtual void SetMinLineWidth(float aLineWidth)
Set the minimum line width in pixels.
KICURSOR m_currentNativeCursor
Current cursor.
bool m_globalFlipY
Flag for Y axis flipping.
float GetMinLineWidth() const
Get the minimum line width in pixels.
bool m_isFillEnabled
Is filling of graphic objects enabled ?
virtual void ComputeWorldScreenMatrix()
Compute the world <-> screen transformation matrix.
COLOR4D m_gridColor
Color of the grid.
COLOR4D m_strokeColor
The color of the outlines.
bool m_isStrokeEnabled
Are the outlines stroked ?
GAL_DISPLAY_OPTIONS & m_options
bool m_gridVisibility
Should the grid be shown.
virtual void BitmapText(const wxString &aText, const VECTOR2I &aPosition, const EDA_ANGLE &aAngle)
Draw a text using a bitmap font.
float GetLineWidth() const
Get the line width.
bool m_globalFlipX
Flag for X axis flipping.
GR_TEXT_V_ALIGN_T GetVerticalJustify() const
KIGFX::CROSS_HAIR_MODE m_crossHairMode
Crosshair drawing mode.
VECTOR2D m_lookAtPoint
Point to be looked at in world space.
GAL(GAL_DISPLAY_OPTIONS &aOptions)
GLuint cacheBitmap(const BITMAP_BASE *aBitmap)
const size_t m_cacheMaxElements
GLuint RequestBitmap(const BITMAP_BASE *aBitmap)
std::list< GLuint > m_freedTextureIds
const size_t m_cacheMaxSize
std::map< const KIID, CACHED_BITMAP > m_bitmaps
std::list< KIID > m_cacheLru
static const unsigned int DIRECT_RENDERING
OpenGL implementation of the Graphics Abstraction Layer.
Definition opengl_gal.h:73
void Transform(const MATRIX3x3D &aTransformation) override
Transform the context.
void drawPolygon(GLdouble *aPoints, int aPointCount)
Draw a filled polygon.
void ChangeGroupDepth(int aGroupNumber, int aDepth) override
Change the depth (Z-axis position) of the group.
void skipMouseEvent(wxMouseEvent &aEvent)
Skip the mouse event to the parent.
void drawSegment(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth, bool aReserve=true)
Internal method for segment drawing.
unsigned int m_groupCounter
Counter used for generating keys for groups.
Definition opengl_gal.h:354
void EndDiffLayer() override
Ends rendering of a differential layer.
VERTEX_MANAGER * m_overlayManager
Container for storing overlaid VERTEX_ITEMs.
Definition opengl_gal.h:359
void Scale(const VECTOR2D &aScale) override
Scale the context.
bool m_isInitialized
Basic initialization flag, has to be done when the window is visible.
Definition opengl_gal.h:379
VERTEX_MANAGER * m_currentManager
Currently used VERTEX_MANAGER (for storing VERTEX_ITEMs).
Definition opengl_gal.h:355
void drawCircle(const VECTOR2D &aCenterPoint, double aRadius, bool aReserve=true)
Internal method for circle drawing.
std::deque< std::shared_ptr< GLdouble > > m_tessIntersects
Definition opengl_gal.h:399
void DrawCircle(const VECTOR2D &aCenterPoint, double aRadius) override
Draw a circle using world coordinates.
void LockContext(int aClientCookie) override
Use GAL_CONTEXT_LOCKER RAII object unless you know what you're doing.
WX_CURSOR_TYPE m_currentwxCursor
wx cursor showing the current native cursor.
Definition opengl_gal.h:393
unsigned int m_mainBuffer
Main rendering target.
Definition opengl_gal.h:366
std::unique_ptr< GL_BITMAP_CACHE > m_bitmapCache
Definition opengl_gal.h:395
std::pair< VECTOR2D, float > computeBitmapTextSize(const UTF8 &aText) const
Compute a size of text drawn using bitmap font with current text setting applied.
void SetTarget(RENDER_TARGET aTarget) override
Set the target for rendering.
void blitCursor()
Blit cursor into the current screen.
static wxString CheckFeatures(GAL_DISPLAY_OPTIONS &aOptions)
Checks OpenGL features.
void ClearTarget(RENDER_TARGET aTarget) override
Clear the target for rendering.
void drawBitmapOverbar(double aLength, double aHeight, bool aReserve=true)
Draw an overbar over the currently drawn text.
void EndGroup() override
End the group.
bool m_isBitmapFontInitialized
Is the shader set to use bitmap fonts?
Definition opengl_gal.h:378
void drawSegmentChain(const std::function< VECTOR2D(int)> &aPointGetter, int aPointCount, double aWidth, bool aReserve=true)
Generic way of drawing a chain of segments stored in different containers.
void DrawArcSegment(const VECTOR2D &aCenterPoint, double aRadius, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aWidth, double aMaxError) override
Draw an arc segment.
void BitmapText(const wxString &aText, const VECTOR2I &aPosition, const EDA_ANGLE &aAngle) override
Draw a text using a bitmap font.
bool updatedGalDisplayOptions(const GAL_DISPLAY_OPTIONS &aOptions) override
Handle updating display options.
unsigned int m_overlayBuffer
Auxiliary rendering target (for menus etc.)
Definition opengl_gal.h:367
void PostPaint(wxPaintEvent &aEvent)
Post an event to #m_paint_listener.
OPENGL_COMPOSITOR * m_compositor
Handles multiple rendering targets.
Definition opengl_gal.h:365
VERTEX_MANAGER * m_cachedManager
Container for storing cached VERTEX_ITEMs.
Definition opengl_gal.h:357
void Translate(const VECTOR2D &aTranslation) override
Translate the context.
void DrawPolyline(const std::deque< VECTOR2D > &aPointList) override
Draw a polyline.
bool SetNativeCursorStyle(KICURSOR aCursor, bool aHiDPI) override
Set the cursor in the native panel.
void DrawCurve(const VECTOR2D &startPoint, const VECTOR2D &controlPointA, const VECTOR2D &controlPointB, const VECTOR2D &endPoint, double aFilterValue=0.0) override
Draw a cubic bezier spline.
void drawFilledSemiCircle(const VECTOR2D &aCenterPoint, double aRadius, double aAngle)
Draw a filled semicircle.
void onPaint(wxPaintEvent &aEvent)
This is the OnPaint event handler.
void DrawGroup(int aGroupNumber) override
Draw the stored group.
GLint ufm_minLinePixelWidth
Definition opengl_gal.h:388
void Restore() override
Restore the context.
void DrawGrid() override
void DrawSegmentChain(const std::vector< VECTOR2D > &aPointList, double aWidth) override
Draw a chain of rounded segments.
void drawStrokedSemiCircle(const VECTOR2D &aCenterPoint, double aRadius, double aAngle, bool aReserve=true)
Draw a stroked semicircle.
unsigned int getNewGroupNumber()
Return a valid key that can be used as a new group number.
void Flush() override
Force all remaining objects to be drawn.
GLint ufm_antialiasingOffset
Definition opengl_gal.h:387
void DeleteGroup(int aGroupNumber) override
Delete the group from the memory.
bool IsVisible() const override
Return true if the GAL canvas is visible on the screen.
Definition opengl_gal.h:113
wxEvtHandler * m_mouseListener
Definition opengl_gal.h:345
int m_swapInterval
Used to store swap interval information.
Definition opengl_gal.h:343
void ClearCache() override
Delete all data created during caching of graphic items.
double getWorldPixelSize() const
void DrawSegment(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth) override
Draw a rounded segment.
GROUPS_MAP m_groups
Stores information about VBO objects (groups)
Definition opengl_gal.h:353
void endUpdate() override
void ClearScreen() override
Clear the screen.
void ResizeScreen(int aWidth, int aHeight) override
Resizes the canvas.
GLint ufm_fontTextureWidth
Definition opengl_gal.h:390
void DrawPolygon(const std::deque< VECTOR2D > &aPointList) override
Draw a polygon.
void drawTriangulatedPolyset(const SHAPE_POLY_SET &aPoly, bool aStrokeTriangulation)
Draw a set of polygons with a cached triangulation.
void DrawCursor(const VECTOR2D &aCursorPosition) override
Draw the cursor.
void DrawRectangle(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
Draw a rectangle.
VERTEX_MANAGER * m_nonCachedManager
Container for storing non-cached VERTEX_ITEMs.
Definition opengl_gal.h:358
int drawBitmapChar(unsigned long aChar, bool aReserve=true)
Draw a single character using bitmap font.
GLUtesselator * m_tesselator
Definition opengl_gal.h:398
wxEvtHandler * m_paintListener
Definition opengl_gal.h:346
void StartDiffLayer() override
Begins rendering of a differential layer.
bool m_isContextLocked
Used for assertion checking.
Definition opengl_gal.h:382
void Save() override
Save the context.
void DrawHoleWall(const VECTOR2D &aCenterPoint, double aHoleRadius, double aWallWidth) override
Draw a hole wall ring.
bool m_isFramebufferInitialized
Are the framebuffers initialized?
Definition opengl_gal.h:376
void ComputeWorldScreenMatrix() override
Compute the world <-> screen transformation matrix.
bool Show(bool aShow) override
Shows/hides the GAL canvas.
void SetMinLineWidth(float aLineWidth) override
Set the minimum line width in pixels.
static GLuint g_fontTexture
Bitmap font texture handle (shared)
Definition opengl_gal.h:348
virtual bool HasTarget(RENDER_TARGET aTarget) override
Return true if the target exists.
void reserveLineQuads(const int aLineCount)
Reserve specified number of line quads.
void DrawLine(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint) override
Draw a line.
OPENGL_GAL(const KIGFX::VC_SETTINGS &aVcSettings, GAL_DISPLAY_OPTIONS &aDisplayOptions, wxWindow *aParent, wxEvtHandler *aMouseListener=nullptr, wxEvtHandler *aPaintListener=nullptr, const wxString &aName=wxT("GLCanvas"))
void beginUpdate() override
double calcAngleStep(double aRadius) const
Compute the angle step when drawing arcs/circles approximated with lines.
Definition opengl_gal.h:590
virtual void DrawGlyph(const KIFONT::GLYPH &aGlyph, int aNth, int aTotal) override
Draw a polygon representing a font glyph.
bool m_isGrouping
Was a group started?
Definition opengl_gal.h:381
void BeginDrawing() override
Start/end drawing functions, draw calls can be only made in between the calls to BeginDrawing()/EndDr...
GLint ufm_screenPixelSize
Definition opengl_gal.h:385
void Rotate(double aAngle) override
Rotate the context.
int BeginGroup() override
Begin a group.
GLint ufm_pixelSizeMultiplier
Definition opengl_gal.h:386
VECTOR2D getScreenPixelSize() const
void DrawBitmap(const BITMAP_BASE &aBitmap, double alphaBlend=1.0) override
Draw a bitmap image.
void drawPolyline(const std::function< VECTOR2D(int)> &aPointGetter, int aPointCount, bool aReserve=true)
Generic way of drawing a polyline stored in different containers.
RENDER_TARGET GetTarget() const override
Get the currently used target for rendering.
void skipGestureEvent(wxGestureEvent &aEvent)
Skip the gesture event to the parent.
void UnlockContext(int aClientCookie) override
void drawSemiCircle(const VECTOR2D &aCenterPoint, double aRadius, double aAngle)
Draw a semicircle.
void drawLineQuad(const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, bool aReserve=true)
Draw a quad for the line.
VERTEX_MANAGER * m_tempManager
Container for storing temp (diff mode) VERTEX_ITEMs.
Definition opengl_gal.h:362
virtual void DrawGlyphs(const std::vector< std::unique_ptr< KIFONT::GLYPH > > &aGlyphs) override
Draw polygons representing font glyphs.
void onSetNativeCursor(wxSetCursorEvent &aEvent)
Give the correct cursor image when the native widget asks for it.
void EnableDepthTest(bool aEnabled=false) override
void EndDrawing() override
End the drawing, needs to be called for every new frame.
SHADER * m_shader
There is only one shader used for different objects.
Definition opengl_gal.h:373
void DrawArc(const VECTOR2D &aCenterPoint, double aRadius, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle) override
Draw an arc.
void DrawPolylines(const std::vector< std::vector< VECTOR2D > > &aPointLists) override
Draw multiple polylines.
RENDER_TARGET m_currentTarget
Current rendering target.
Definition opengl_gal.h:369
wxGLContext * m_glPrivContext
Canvas-specific OpenGL context.
Definition opengl_gal.h:342
void ChangeGroupColor(int aGroupNumber, const COLOR4D &aNewColor) override
Change the color used to draw the group.
static bool m_isBitmapFontLoaded
Is the bitmap font texture loaded?
Definition opengl_gal.h:377
static wxGLContext * m_glMainContext
Parent OpenGL context.
Definition opengl_gal.h:341
void setupShaderParameters()
Set up the shader parameters for OpenGL rendering.
unsigned int m_tempBuffer
Temporary rendering target (for diffing etc.)
Definition opengl_gal.h:368
void init()
Basic OpenGL initialization and feature checks.
static int m_instanceCounter
GL GAL instance counter.
Definition opengl_gal.h:344
Provide the access to the OpenGL shaders.
Definition shader.h:77
Class to control vertex container and GPU with possibility of emulating old-style OpenGL 1....
bool Vertex(const VERTEX &aVertex)
Add a vertex with the given coordinates to the currently set item.
Definition kiid.h:48
VECTOR2< T > GetScale() const
Get the scale components of the matrix.
Definition matrix3x3.h:295
T m_data[3][3]
Definition matrix3x3.h:65
GL_CONTEXT_MANAGER * GetGLContextManager()
Definition pgm_base.h:120
A small class to help profiling.
Definition profile.h:49
void Stop()
Save the time when this function was called, and set the counter stane to stop.
Definition profile.h:88
void Start()
Start or restart the counter.
Definition profile.h:77
std::string to_string()
Definition profile.h:155
double msecs(bool aSinceLast=false)
Definition profile.h:149
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
bool IsClosed() const override
int PointCount() const
Return the number of points (vertices) in this line chain.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
int SegmentCount() const
Return the number of segments in this line chain.
void GetTriangle(int index, VECTOR2I &a, VECTOR2I &b, VECTOR2I &c) const
Represent a set of closed polygons.
bool IsTriangulationUpToDate() const
POLYGON & Polygon(int aIndex)
Return the aIndex-th subpolygon in the set.
const TRIANGULATED_POLYGON * TriangulatedPolygon(int aIndex) const
unsigned int TriangulatedPolyCount() const
Return the number of triangulated polygons.
int OutlineCount() const
Return the number of outlines in the set.
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
uni_iter is a non-mutating iterator that walks through unicode code points in the UTF8 encoded string...
Definition utf8.h:230
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
Definition utf8.h:71
uni_iter uend() const
Return a uni_iter initialized to the end of "this" UTF8 byte sequence.
Definition utf8.h:313
uni_iter ubegin() const
Returns a uni_iter initialized to the start of "this" UTF8 byte sequence.
Definition utf8.h:305
T EuclideanNorm() const
Compute the Euclidean norm of the vector, which is defined as sqrt(x ** 2 + y ** 2).
Definition vector2d.h:283
@ BLUE
Definition color4d.h:56
KICURSOR
Definition cursors.h:44
static constexpr EDA_ANGLE FULL_CIRCLE
Definition eda_angle.h:409
a few functions useful in geometry calculations.
int GetArcToSegmentCount(int aRadius, int aErrorMax, const EDA_ANGLE &aArcAngle)
const wxChar *const traceGalProfile
Flag to enable debug output of GAL performance profiling.
KIID niluuid(0)
This file contains miscellaneous commonly used macros and functions.
MATRIX3x3< double > MATRIX3x3D
Definition matrix3x3.h:473
#define H(x, y, z)
Definition md5_hash.cpp:17
FONT_IMAGE_TYPE font_image
const FONT_GLYPH_TYPE * LookupGlyph(unsigned int aCodepoint)
FONT_INFO_TYPE font_information
The Cairo implementation of the graphics abstraction layer.
Definition eda_group.h:33
@ SMALL_CROSS
Use small cross instead of dots for the grid.
@ DOTS
Use dots for the grid.
@ SHADER_NONE
@ SHADER_LINE_C
@ SHADER_LINE_B
@ SHADER_FONT
@ SHADER_LINE_F
@ SHADER_LINE_E
@ SHADER_STROKED_CIRCLE
@ SHADER_HOLE_WALL
@ SHADER_LINE_A
@ SHADER_LINE_D
@ SHADER_FILLED_CIRCLE
@ SHADER_TYPE_VERTEX
Vertex shader.
Definition shader.h:46
@ SHADER_TYPE_FRAGMENT
Fragment shader.
Definition shader.h:47
RENDER_TARGET
RENDER_TARGET: Possible rendering targets.
Definition definitions.h:36
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
Definition definitions.h:38
@ TARGET_TEMP
Temporary target for drawing in separate layer.
Definition definitions.h:40
@ TARGET_CACHED
Main rendering target (cached)
Definition definitions.h:37
@ TARGET_OVERLAY
Items that may change while the view stays the same (noncached)
Definition definitions.h:39
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition eda_angle.h:400
static const wxChar *const traceGalXorMode
static void InitTesselatorCallbacks(GLUtesselator *aTesselator)
void CALLBACK CombineCallback(GLdouble coords[3], GLdouble *vertex_data[4], GLfloat weight[4], GLdouble **dataOut, void *aData)
void CALLBACK VertexCallback(GLvoid *aVertexPtr, void *aData)
void CALLBACK EdgeCallback(GLboolean aEdgeFlag)
static wxGLAttributes getGLAttribs()
void CALLBACK ErrorCallback(GLenum aErrorCode)
double round_to_half_pixel(double f, double r)
#define SEG_PER_CIRCLE_COUNT
Definition opengl_gal.h:53
#define CALLBACK
The default number of points for circle approximation.
Definition opengl_gal.h:49
PGM_BASE & Pgm()
The global program "get" accessor.
see class PGM_BASE
const int scale
std::vector< FAB_LAYER_COLOR > dummy
VERTEX_MANAGER * vboManager
Manager used for storing new vertices.
Definition opengl_gal.h:331
std::deque< std::shared_ptr< GLdouble > > & intersectPoints
Intersect points, that have to be freed after tessellation.
Definition opengl_gal.h:334
Structure to keep VIEW_CONTROLS settings for easy store/restore operations.
VECTOR3I v1(5, 5, 5)
nlohmann::json output
VECTOR2I end
VECTOR2I v2(1, 0)
@ GR_TEXT_H_ALIGN_CENTER
@ GR_TEXT_H_ALIGN_RIGHT
@ GR_TEXT_H_ALIGN_LEFT
@ GR_TEXT_H_ALIGN_INDETERMINATE
@ GR_TEXT_V_ALIGN_BOTTOM
@ GR_TEXT_V_ALIGN_INDETERMINATE
@ GR_TEXT_V_ALIGN_CENTER
@ GR_TEXT_V_ALIGN_TOP
#define M_PI
wxLogTrace helper definitions.
#define KI_TRACE(aWhat,...)
void enableGlDebug(bool aEnable)
Enable or disable OpenGL driver messages output.
Definition utils.cpp:188
int checkGlError(const std::string &aInfo, const char *aFile, int aLine, bool aThrow)
Check if a recent OpenGL operation has failed.
Definition utils.cpp:45
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:687
VECTOR2< double > VECTOR2D
Definition vector2d.h:686
VECTOR2I ToVECTOR2I(const wxSize &aSize)
Definition vector2wx.h:30