vglModule.renderWindow.rst

vgl.renderWindow (class)

.. js:class:: vgl.renderWindow (canvas)



   .. ============================== constructor details ====================








   Create a new instance of class renderWindow




   :param  canvas:















   :returns:



     :rtype: vgl.renderWindow














   .. ============================== properties summary =====================



   .. ============================== events summary ========================





   .. ============================== field details ==========================



   .. ============================== method details =========================






   .. js:function:: vgl.renderWindow.windowSize()





       Get size of the render window












       :returns:


       :rtype: Array










   .. js:function:: vgl.renderWindow.setWindowSize(width, height)





       :param  width:





       :param  height:







       Set size of the render window












       :returns:


       :rtype: boolean










   .. js:function:: vgl.renderWindow.windowPosition()





       Get window position (top left coordinates)












       :returns:


       :rtype: Array










   .. js:function:: vgl.renderWindow.setWindowPosition(x, y)





       :param  x:





       :param  y:







       Set window position (top left coordinates)












       :returns:


       :rtype: boolean










   .. js:function:: vgl.renderWindow.renderers()





       Return all renderers contained in the render window












       :returns:


       :rtype: Array










   .. js:function:: vgl.renderWindow.activeRenderer()





       Get active renderer of the the render window












       :returns:
         vgl.renderer












   .. js:function:: vgl.renderWindow.addRenderer(ren)





       :param  ren:







       Add renderer to the render window












       :returns:


       :rtype: boolean










   .. js:function:: vgl.renderWindow.removeRenderer(ren)





       :param  ren:







       Remove renderer from the render window












       :returns:


       :rtype: boolean










   .. js:function:: vgl.renderWindow.getRenderer(index)





       :param  index:







       Return a renderer at a given index












       :returns:


       :rtype: vgl.renderer










   .. js:function:: vgl.renderWindow.hasRenderer(ren)





       :param  ren:







       Check if the renderer exists












       :returns:


       :rtype: boolean










   .. js:function:: vgl.renderWindow.resize(width, height)





       :param  width:





       :param  height:







       Resize window



















   .. js:function:: vgl.renderWindow.positionAndResize(x, y, width, height)





       :param  x:





       :param  y:





       :param  width:





       :param  height:







       Resize and reposition the window



















   .. js:function:: vgl.renderWindow.createWindow()





       Create the window












       :returns:


       :rtype: boolean










   .. js:function:: vgl.renderWindow.deleteWindow()





       Delete this window and release any graphics resources



















   .. js:function:: vgl.renderWindow.render()





       Render the scene



















   .. js:function:: vgl.renderWindow.focusDisplayPoint()





       Get the focusDisplayPoint from the activeRenderer












       :returns:


       :rtype: vec4










   .. js:function:: vgl.renderWindow.displayToWorld(x, y, focusDisplayPoint)





       :param Number x:





       :param Number y:





       :param vec4 focusDisplayPoint:







       Transform a point in display space to world space












       :returns:


       :rtype: vec4









   .. ============================== event details =========================

Documentation generated by jsdoc-toolkit 2.4.0 using jsdoc-toolkit-rst-template