Manages slide rendering by coordinating between the SkiaStitchingPipeline and SlideGLArea Handles async updates, caching, and progressive rendering for large pyramidal images. More...

Inheritance diagram for BioGTK.SKSlideRenderer:

Classes
class	CacheStatistics

Public Member Functions
	SKSlideRenderer (SKDrawingArea sk)
	Initialize renderer for a specific GLArea widget.

void	SetSource (OpenSlideGTK.OpenSlideBase openSlideSource)
	Set OpenSlide source and initialize pipeline.

void	SetSource (SlideBase slideSource)
	Set BioLib slide source and initialize pipeline.

void	InvalidateRenderState ()
	Marks any in-flight render as stale so the next viewport update can replace it without the old result winning the race.

async Task	UpdateViewAsync (PointD origin, double resolution, ZCT coordinate, int width=600, int height=400)
	Update the rendered view asynchronously - main entry point for rendering.

SKImage	RenderRegion (RectangleD region, int level, ZCT coordinate, double resolution, int pxwidth, int pxheight)
	Render a specific region synchronously (for exports, small areas)

SKImage	RenderCurrentViewSync ()
	Render current viewport synchronously (blocking)

SKImage	GetCurrentImage ()
	Get the current image for rendering - called by GLArea during draw Returns the best available image (full quality or preview)

void	DrawToCanvas (SKCanvas canvas, int canvasWidth, int canvasHeight)
	Draw the current image to a canvas with proper scaling Called during the Skia render callback from SlideGLArea.

void	ClearCache ()
	Clear the tile cache.

CacheStatistics	GetCacheStatistics ()
	Get cache statistics for monitoring.

void	UpdateConfiguration (int? maxCacheSizeMB=null, int? tileSize=null, SKSamplingOptions? sampling=null, bool? enablePrefetch=null, bool? enableProgressiveRendering=null)
	Update renderer configuration and reinitialize if needed.

void	Dispose ()

Properties
bool	LastRenderSkipped `[get]`
	True if the last UpdateViewAsync call was skipped because a render was already in progress.

int	MaxCacheSizeMB = 512 `[get, set]`

int	TileSize = 256 `[get, set]`

SKSamplingOptions	Sampling = SKSamplingOptions.Default `[get, set]`

bool	EnablePrefetch = true `[get, set]`

bool	IsRendering `[get]`

bool	HasValidImage `[get]`

Detailed Description

Manages slide rendering by coordinating between the SkiaStitchingPipeline and SlideGLArea Handles async updates, caching, and progressive rendering for large pyramidal images.

Definition at line 15 of file SKSlideRenderer.cs.

Constructor & Destructor Documentation

◆ SKSlideRenderer()

BioGTK.SKSlideRenderer.SKSlideRenderer ( SKDrawingArea sk )

Initialize renderer for a specific GLArea widget.

Definition at line 55 of file SKSlideRenderer.cs.

        {
            InitializeDefaults();
        }

Member Function Documentation

◆ ClearCache()

void BioGTK.SKSlideRenderer.ClearCache ( )

Clear the tile cache.

Definition at line 429 of file SKSlideRenderer.cs.

        {
            _stitchingPipeline?.ClearCache();
        }

◆ Dispose()

void BioGTK.SKSlideRenderer.Dispose ( )

Definition at line 494 of file SKSlideRenderer.cs.

        {
            if (_disposed)
                return;
 
            _disposed = true;
            _currentRenderedImage?.Dispose();       
            _stitchingPipeline?.Dispose();
            _currentRenderedImage = null;
            _stitchingPipeline = null;
        }

◆ DrawToCanvas()

void BioGTK.SKSlideRenderer.DrawToCanvas	(	SKCanvas	canvas,
		int	canvasWidth,
		int	canvasHeight )

Draw the current image to a canvas with proper scaling Called during the Skia render callback from SlideGLArea.

Definition at line 349 of file SKSlideRenderer.cs.

        {
            if (canvas == null)
                return;
 
            var image = GetCurrentImage();
            if (image == null)
                return;
            try
            {
                using (var paint = new SKPaint
                {
                    IsAntialias = true,
                    BlendMode = SKBlendMode.SrcOver
                })
                {
                    // Draw image to fill canvas
                    var destRect = new SKRect(0, 0, canvasWidth, canvasHeight);
                    canvas.DrawImage(image, destRect, paint);
                }
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error drawing to canvas: {ex.Message}");
            }
        }

◆ GetCacheStatistics()

CacheStatistics BioGTK.SKSlideRenderer.GetCacheStatistics ( )

Get cache statistics for monitoring.

Definition at line 437 of file SKSlideRenderer.cs.

        {
            // Could be extended to expose actual stats from pipeline
            return new CacheStatistics
            {
                IsEnabled = _stitchingPipeline != null,
                MaxSizeMB = MaxCacheSizeMB,
                TileSize = TileSize
            };
        }

◆ GetCurrentImage()

SKImage BioGTK.SKSlideRenderer.GetCurrentImage ( )

Get the current image for rendering - called by GLArea during draw Returns the best available image (full quality or preview)

Definition at line 339 of file SKSlideRenderer.cs.

        {
            // Return full quality if available, otherwise preview
            return _currentRenderedImage;
        }

◆ InvalidateRenderState()

void BioGTK.SKSlideRenderer.InvalidateRenderState ( )

Marks any in-flight render as stale so the next viewport update can replace it without the old result winning the race.

Definition at line 148 of file SKSlideRenderer.cs.

        {
            Interlocked.Increment(ref _renderStateVersion);
        }

◆ RenderCurrentViewSync()

SKImage BioGTK.SKSlideRenderer.RenderCurrentViewSync ( )

Render current viewport synchronously (blocking)

Definition at line 317 of file SKSlideRenderer.cs.

        {
            if (!_hasSource || _stitchingPipeline == null)
                return null;
 
            return _stitchingPipeline.StitchViewportAsync(
                _lastOrigin,
                _lastResolution,
                _lastCoordinate,
                _lastWidth,
                _lastHeight
            ).Result;
        }

◆ RenderRegion()

SKImage BioGTK.SKSlideRenderer.RenderRegion	(	RectangleD	region,
		int	level,
		ZCT	coordinate,
		double	resolution,
		int	pxwidth,
		int	pxheight )

Render a specific region synchronously (for exports, small areas)

Definition at line 303 of file SKSlideRenderer.cs.

        {
            if (!_hasSource || _stitchingPipeline == null)
                return null;
 
            return _stitchingPipeline.StitchRegion(region, level, coordinate, resolution, pxwidth, pxheight);
        }

◆ SetSource() [1/2]

void BioGTK.SKSlideRenderer.SetSource ( OpenSlideGTK.OpenSlideBase openSlideSource )

Set OpenSlide source and initialize pipeline.

Definition at line 76 of file SKSlideRenderer.cs.

        {
            if (openSlideSource == null)
                throw new ArgumentNullException(nameof(openSlideSource));
 
            ClearCurrentSource();
 
            _openSlideSource = openSlideSource;
            _isOpenSlide = true;
            _hasSource = true;
 
            InitializeStitchingPipeline();
        }

◆ SetSource() [2/2]

void BioGTK.SKSlideRenderer.SetSource ( SlideBase slideSource )

Set BioLib slide source and initialize pipeline.

Definition at line 93 of file SKSlideRenderer.cs.

        {
            if (slideSource == null)
                throw new ArgumentNullException(nameof(slideSource));
 
            ClearCurrentSource();
 
            _slideSource = slideSource;
            _isOpenSlide = false;
            _hasSource = true;
 
            InitializeStitchingPipeline();
        }

◆ UpdateConfiguration()

void BioGTK.SKSlideRenderer.UpdateConfiguration	(	int?	maxCacheSizeMB = null,
		int?	tileSize = null,
		SKSamplingOptions?	sampling = null,
		bool?	enablePrefetch = null,
		bool?	enableProgressiveRendering = null )

Update renderer configuration and reinitialize if needed.

Definition at line 462 of file SKSlideRenderer.cs.

        {
            bool needsReinit = false;
 
            if (maxCacheSizeMB.HasValue && maxCacheSizeMB.Value != MaxCacheSizeMB)
            {
                MaxCacheSizeMB = maxCacheSizeMB.Value;
                needsReinit = true;
            }
 
            if (tileSize.HasValue && tileSize.Value != TileSize)
            {
                TileSize = tileSize.Value;
                needsReinit = true;
            }
 
            // Reinitialize pipeline if structural changes were made
            if (needsReinit && _hasSource)
            {
                InitializeStitchingPipeline();
            }
        }

◆ UpdateViewAsync()

async Task BioGTK.SKSlideRenderer.UpdateViewAsync	(	PointD	origin,
		double	resolution,
		ZCT	coordinate,
		int	width = 600,
		int	height = 400 )

Update the rendered view asynchronously - main entry point for rendering.

Definition at line 160 of file SKSlideRenderer.cs.

        {
            if (_disposed || !_hasSource || _stitchingPipeline == null)
                return;
 
            // If a render is already in progress, record the skip and return.
            // The finally block of the running render will re-schedule via RequestDeferredRender.
            if (!_renderSemaphore.Wait(0))
            {
                LastRenderSkipped = true;
                return;
            }
 
            // We hold the semaphore — clear the skip flag and run.
            LastRenderSkipped = false;
            int renderVersion = _renderStateVersion;
 
            try
            {
                IsRendering = true;
 
                // Store current parameters
                _lastOrigin = origin;
                _lastResolution = resolution;
                _lastCoordinate = coordinate;
                _lastWidth = width;
                _lastHeight = height;
 
                await RenderFullQualityAsync(origin, resolution, coordinate, width, height, renderVersion);
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error during view update: {ex.Message}");
            }
            finally
            {
                IsRendering = false;
                _renderSemaphore.Release();
 
                // If a request was skipped while we were running, reschedule so the
                // view always ends up showing the latest coordinates.
                if (!_disposed && LastRenderSkipped)
                    Gtk.Application.Invoke((s, a) => App.viewer?.RequestDeferredRender());
            }
        }

Property Documentation

◆ EnablePrefetch

bool BioGTK.SKSlideRenderer.EnablePrefetch = true

getset

Definition at line 42 of file SKSlideRenderer.cs.

42{ get; set; } = true;

◆ HasValidImage

bool BioGTK.SKSlideRenderer.HasValidImage

get

Definition at line 46 of file SKSlideRenderer.cs.

◆ IsRendering

bool BioGTK.SKSlideRenderer.IsRendering

get

Definition at line 45 of file SKSlideRenderer.cs.

45{ get; private set; }

◆ LastRenderSkipped

bool BioGTK.SKSlideRenderer.LastRenderSkipped

get

True if the last UpdateViewAsync call was skipped because a render was already in progress.

Definition at line 20 of file SKSlideRenderer.cs.

20{ get; private set; }

◆ MaxCacheSizeMB

int BioGTK.SKSlideRenderer.MaxCacheSizeMB = 512

getset

Definition at line 39 of file SKSlideRenderer.cs.

39{ get; set; } = 512;

◆ Sampling

SKSamplingOptions BioGTK.SKSlideRenderer.Sampling = SKSamplingOptions.Default

getset

Definition at line 41 of file SKSlideRenderer.cs.

41{ get; set; } = SKSamplingOptions.Default;

◆ TileSize

int BioGTK.SKSlideRenderer.TileSize = 256

getset

Definition at line 40 of file SKSlideRenderer.cs.

40{ get; set; } = 256;

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

BioGTK/BioGTK/Source/SKSlideRenderer.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SKSlideRenderer()

Member Function Documentation

◆ ClearCache()

◆ Dispose()

◆ DrawToCanvas()

◆ GetCacheStatistics()

◆ GetCurrentImage()

◆ InvalidateRenderState()

◆ RenderCurrentViewSync()

◆ RenderRegion()

◆ SetSource() [1/2]

◆ SetSource() [2/2]

◆ UpdateConfiguration()

◆ UpdateViewAsync()

Property Documentation

◆ EnablePrefetch

◆ HasValidImage

◆ IsRendering

◆ LastRenderSkipped

◆ MaxCacheSizeMB

◆ Sampling

◆ TileSize