Skip to content

Add initialization methods to the cpp docs #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marndorfer wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add initialization methods to the cpp docs #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions cpp/source/basics/initializing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,20 @@ polyscope::show();
`backend` is an optional specifier for which [rendering backend]([[url.prefix]]/building#backends) to use, passing `""` selects a reasonable default backend. Generally, you should not need to manually set the backend.


??? func "`#!cpp checkInitialized()`"

##### checkInitialized()

Check if polyscope has been initialized, if not an error is thrown.


??? func "`#!cpp isInitialized()`"

##### isInitialized()

Returns true if the state of polyscope is initialized and false if not.


??? func "`#!cpp show()`"

##### show()
Expand Down