[Mesa-dev] [PATCH 1/2] gallium/docs: clarify gen_name/get_vendor/get_device_vendor behavior
Marek Olšák
maraeo at gmail.com
Fri Jun 9 13:49:05 UTC 2017
From: Marek Olšák <marek.olsak at amd.com>
---
src/gallium/docs/source/screen.rst | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/src/gallium/docs/source/screen.rst b/src/gallium/docs/source/screen.rst
index 852c31b..288fb5c 100644
--- a/src/gallium/docs/source/screen.rst
+++ b/src/gallium/docs/source/screen.rst
@@ -617,31 +617,40 @@ no matter which hint they got.
Methods
-------
XXX to-do
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
^^^^^^^^^
Get an integer/boolean screen parameter.
**param** is one of the :ref:`PIPE_CAP` names.
.. _get_paramf:
--
2.7.4
More information about the mesa-dev
mailing list