rgl.init: Initializing RGL

Description Usage Arguments Details Value

View source: R/zzz.R

Description

Initializing the RGL system.

Usage

1
2
rgl.init(initValue = 0, onlyNULL = FALSE, 
         debug = getOption("rgl.debug", FALSE))

Arguments

initValue

value for internal use only

onlyNULL

only initialize the null (no display) device

debug

enable some debugging messages

Details

If useNULL is TRUE, RGL will use a “null” device. This device records objects as they are plotted, but displays nothing. It is intended for use with rglwidget and similar functions.

Currently debug only controls messages printed by the OpenGL library during initialization. In future debug = TRUE may become more verbose.

For display within an OpenGL window in R, RGL requires the OpenGL system to be installed and available. If there is a problem initializing it, you may see the message 'rgl.init' failed, running with 'rgl.useNULL = TRUE'. There are several causes and remedies:

Value

Normally the user doesn't call rgl.init at all: it is called when the package is loaded. It returns no useful value.


rgl documentation built on April 17, 2021, 9:07 a.m.