summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarek Olšák <[email protected]>2017-06-07 23:18:09 +0200
committerMarek Olšák <[email protected]>2017-06-12 18:24:37 +0200
commit7448342a1f51f928611f3f7aefa7f2180aa05ecf (patch)
treea3bd1c8a2bbd0bc054f9e9f2b3174df4c308869b
parent0d62e8a727cfd3327e21fdda1a3e95a81e2c7f0b (diff)
gallium/docs: clarify gen_name/get_vendor/get_device_vendor behavior
Reviewed-by: Nicolai Hähnle <[email protected]>
-rw-r--r--src/gallium/docs/source/screen.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/gallium/docs/source/screen.rst b/src/gallium/docs/source/screen.rst
index 852c31b24c3..288fb5cb3cc 100644
--- a/src/gallium/docs/source/screen.rst
+++ b/src/gallium/docs/source/screen.rst
@@ -624,17 +624,26 @@ get_name
Returns an identifying name for the screen.
+The returned string should remain valid and immutable for the lifetime of
+pipe_screen.
+
get_vendor
^^^^^^^^^^
Returns the screen vendor.
+The returned string should remain valid and immutable for the lifetime of
+pipe_screen.
+
get_device_vendor
^^^^^^^^^^^^^^^^^
Returns the actual vendor of the device driving the screen
(as opposed to the driver vendor).
+The returned string should remain valid and immutable for the lifetime of
+pipe_screen.
+
.. _get_param:
get_param