Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-renderdoc Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:59:57 2022 GMT+0.
Next: Systems, Previous: The cl-renderdoc Reference Manual, Up: The cl-renderdoc Reference Manual [Contents][Index]
Wrappers for the renderdoc in application api
This library is neither necessary nor sufficient for getting started using renderdoc with lisp, although the getting set up section provides some high-level instructions for that. All this library does is wrap the in-application API, which allows some programmatic control over renderdoc from inside your lisp code.
renderdoccmd capture -w sbcl
(asdf:load-system :cl-renderdoc)
Now you should be ready to call any functions exposed by the renderdoc API on your GL main thread.
The command given in step 1 works as a lisp implementation command for sly at least. At this time passing it directly to slime has not been tested.
There are only a few functions currently wrapped:
cl-renderdoc:get-api-version
(GetAPIVersion): Returns the current API versioncl-renderdoc:trigger-capture
(TriggerCapture): Triggers a capture of the next complete framecl-renderdoc:launch-replay-ui
(LaunchReplayUI): Start the graphical capture inspector attached to this processcl-renderdoc:get-overlay-bits
(GetOverlayBits): Get the flags describing the current state of the overlaycl-renderdoc:mask-overlay-bits
(MaskOverlayBits): Enable/disable parts of the overlayI have only tested calling them on the thread holding my GL context, but they do not block. The first four can be called
without any arguments and should "just work". trigger-capture
will record any GL commands for the current frame,
launch-replay-ui
will open the renderdoc capture inspector attached to the current process.
Wrapping additional functions is more tedious than difficult- cl-autowrap has done a decent chunk of the work, but each function still needs to have a little bit of additional glue code written due to the design of the underlying api.
Next: Modules, Previous: Introduction, Up: The cl-renderdoc Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Wrapper around the renderdoc In-Application API for Common Lisp
Elijah Malaby <emalaby@mail.usf.edu>
MIT
0.0.1
cl-autowrap (system).
Next: Files, Previous: Systems, Up: The cl-renderdoc Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
cl-renderdoc (system).
renderdoc_app.h (file).
Next: Packages, Previous: Modules, Up: The cl-renderdoc Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-renderdoc/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-renderdoc (system).
Next: cl-renderdoc/cl-renderdoc.lisp, Previous: cl-renderdoc/cl-renderdoc.asd, Up: Lisp [Contents][Index]
autowrap-spec (module).
cl-renderdoc (system).
Previous: cl-renderdoc/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
cl-renderdoc (system).
Next: Definitions, Previous: Files, Up: The cl-renderdoc Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: cl-renderdoc, Previous: Packages, Up: Packages [Contents][Index]
autowrap.
Previous: cl-renderdoc-int, Up: Packages [Contents][Index]
Next: Indexes, Previous: Packages, Up: The cl-renderdoc Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]
Next: Structures, Previous: Special variables, Up: Public Interface [Contents][Index]
Previous: Ordinary functions, Up: Public Interface [Contents][Index]
wrapper.
wrapper.
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Structures, Previous: Internals, Up: Internals [Contents][Index]
Previous: Ordinary functions, Up: Internals [Contents][Index]
wrapper.
wrapper.
wrapper.
wrapper.
Previous: Definitions, Up: The cl-renderdoc Reference Manual [Contents][Index]
Jump to: | (
_
C F G L M N R T |
---|
Jump to: | (
_
C F G L M N R T |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | *
+
S |
---|
Jump to: | *
+
S |
---|
Jump to: | _
A C F M P R S |
---|
Jump to: | _
A C F M P R S |
---|