summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJean-Philippe Andre <jp.andre@samsung.com>2015-03-16 15:06:55 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2015-03-16 15:10:57 +0900
commit786878b3c6939a423584b86e77c6f591ee3e2dbe (patch)
tree271f7ef3d256f2007b6f0b3077d87c7e11919343
parent47b5ce6da8a2ce0ca6e36c6f11bec190895806f9 (diff)
elm_config: Add doc for the new depth/stencil/msaa preference
-rw-r--r--src/lib/elm_config.h23
1 files changed, 21 insertions, 2 deletions
diff --git a/src/lib/elm_config.h b/src/lib/elm_config.h
index 6b625b8df..0e15d53e6 100644
--- a/src/lib/elm_config.h
+++ b/src/lib/elm_config.h
@@ -908,13 +908,32 @@ EAPI const char *elm_config_accel_preference_get(void);
908 * Note that it will take effect only to Elementary windows created after 908 * Note that it will take effect only to Elementary windows created after
909 * this is called. The @p pref string is a freeform C string that indicates 909 * this is called. The @p pref string is a freeform C string that indicates
910 * what kind of acceleration is preferred. Here "acceleration" majorly 910 * what kind of acceleration is preferred. Here "acceleration" majorly
911 * means to rendering and which hardware unit application renders guis with. 911 * means to rendering and which hardware unit application renders GUIs with.
912 * This may or may not be honored, but a best attempt will 912 * This may or may not be honored, but a best attempt will
913 * be made. Known strings are as follows: 913 * be made. Known strings are as follows:
914 * 914 *
915 * "gl", "opengl" - try use opengl. 915 * "gl", "opengl" - try use OpenGL.
916 * "3d" - try and use a 3d acceleration unit. 916 * "3d" - try and use a 3d acceleration unit.
917 * "hw", "hardware", "accel" - try any acceleration unit (best possible) 917 * "hw", "hardware", "accel" - try any acceleration unit (best possible)
918 *
919 * Since 1.14, it is also possible to specify some GL properties for the GL
920 * window surface. This allows applications to use GLView with depth, stencil
921 * and MSAA buffers with direct rendering. The new accel preference string
922 * format is thus "{HW Accel}[:depth{value}[:stencil{value}[:msaa{str}]]]".
923 *
924 * Accepted values for depth are for instance "depth", "depth16", "depth24".
925 * Accepted values for stencil are "stencil", "stencil1", "stencil8".
926 * For MSAA, only predefined strings are accepted: "msaa", "msaa_low",
927 * "msaa_mid" and "msaa_high". The selected configuration is not garanteed
928 * and is only valid in case of GL acceleration. Only the base acceleration
929 * string will be saved (e.g. "gl" or "hw").
930 *
931 * Full examples include:
932 *
933 * "gl", - try to use OpenGL
934 * "hw:depth:stencil", - use HW acceleration with default depth and stencil buffers
935 * "opengl:depth24:stencil8:msaa_mid" - use OpenGL with 24-bit depth,
936 * 8-bit stencil and a medium number of MSAA samples in the backbuffer.
918 * 937 *
919 * This takes precedence over engine preferences set with 938 * This takes precedence over engine preferences set with
920 * elm_config_preferred_engine_set(). 939 * elm_config_preferred_engine_set().