Skip to content

Commit

Permalink
Disable shadows in Mac by default. Add comments in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
costashatz committed Sep 25, 2024
1 parent 51e1cb0 commit 9412aa2
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
16 changes: 16 additions & 0 deletions src/docs/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -449,3 +449,19 @@ endif()
!!! note "[C++ examples](https://github.com/NOSALRO/robot_dart/tree/master/src/examples)"

!!! note "[Python examples](https://github.com/NOSALRO/robot_dart/tree/master/src/examples/python)"

## **Known Issues**

### Graphics issues on Mac

Recent versions of macOS do not fully support OpenGL (see [here](https://developer.apple.com/library/archive/documentation/GraphicsImaging/Conceptual/OpenGL-MacProgGuide/opengl_intro/opengl_intro.html)). RobotDART is using OpenGL for its graphical interface. For this reason, you might experience one of the following issues:

- Segfaults when shadows are enabled (see [here](https://github.com/NOSALRO/robot_dart/issues/204)). For this reason, **on Mac PCs we are disabling by default the shadows**.
- Status bar not showing correctly or not at all (see [here](https://github.com/NOSALRO/robot_dart/issues/205))
- When using RobotDART with a graphics window (*remember that you can use RobotDART with graphics without any window!*), saving images or videos might not work properly (see [here](https://github.com/NOSALRO/robot_dart/issues/209))

Finally, although not an issue, but this is related to Mac not fully supporting OpenGL, `Windowsless GLContext` is unsupported in Mac. Thus, a few examples (like `example_parallel.py`, see [here](https://github.com/NOSALRO/robot_dart/issues/208)) are not working on Mac PCs.

### Graphics issues on WSL (Windows)

You might experience some issues with the graphical interface (see [here](https://github.com/NOSALRO/robot_dart/issues/214)).
2 changes: 1 addition & 1 deletion src/docs/include/macros.py

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions src/robot_dart/gui/magnum/base_application.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,14 @@ namespace robot_dart {
std::string title = "DART";

// Shadows
#ifndef MAGNUM_MAC_OSX
bool shadowed = true;
bool transparent_shadows = true;
#else
// Disabling shadows by default on OSX
bool shadowed = false;
bool transparent_shadows = false;
#endif
size_t shadow_map_size = 1024;

// Lights
Expand Down

0 comments on commit 9412aa2

Please sign in to comment.