#
# offscreenslicecanvas.py - The OffScreenSliceCanvas.
#
# Author: Paul McCarthy <pauldmccarthy@gmail.com>
#
"""This module provides the :class:`OffScreenSliceCanvas`, which is a
:class:`.SliceCanvas` for use in off-screen OpenGL rendering.
"""
import fsleyes.gl as fslgl
from . import slicecanvas as sc
[docs]class OffScreenSliceCanvas(sc.SliceCanvas, fslgl.OffScreenCanvasTarget):
"""The ``OffScreenSliceCanvas`` is a :class:`.SliceCanvas` which uses
a :class:`.RenderTexture` as its target, for static off-screen OpenGL
rendering.
"""
[docs] def __init__(self,
overlayList,
displayCtx,
zax,
*args,
**kwargs):
"""Create an ``OffScreenSliceCanvas``.
See the :class:`.SliceCanvas` and :class:`.OffscreenCanvasTarget`
classes for details on the other arguments.
"""
fslgl.OffScreenCanvasTarget.__init__(self, *args, **kwargs)
sc.SliceCanvas .__init__(self,
overlayList,
displayCtx,
zax)