aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2023-01-12 10:30:10 -0500
committerDavid Robillard <d@drobilla.net>2023-01-14 11:53:28 -0500
commitbd4f79646f623e929e6aa22bea028952b515aeef (patch)
treee2dcc2635bb2b12b9c552755b35a0343005ce88a /doc
parent786a28e4a2bc9fce95a8d2e6cd1a4c76d2ae1a0f (diff)
downloadpugl-bd4f79646f623e929e6aa22bea028952b515aeef.tar.gz
pugl-bd4f79646f623e929e6aa22bea028952b515aeef.tar.bz2
pugl-bd4f79646f623e929e6aa22bea028952b515aeef.zip
Add general string hint interface
This replaces the window title and class name APIs with a more general one that can be easily extended to other things, like icon names, more detailed application hints, and so on.
Diffstat (limited to 'doc')
-rw-r--r--doc/c/view.rst2
-rw-r--r--doc/c/world.rst4
2 files changed, 3 insertions, 3 deletions
diff --git a/doc/c/view.rst b/doc/c/view.rst
index ff8d3db..0a26e14 100644
--- a/doc/c/view.rst
+++ b/doc/c/view.rst
@@ -31,7 +31,7 @@ For example:
const PuglSpan defaultWidth = 1920;
const PuglSpan defaultHeight = 1080;
- puglSetWindowTitle(view, "My Window");
+ puglSetViewString(view, PUGL_WINDOW_TITLE, "My Window");
puglSetSizeHint(view, PUGL_DEFAULT_SIZE, 1920, 1080);
puglSetSizeHint(view, PUGL_MIN_SIZE, 640, 480);
puglSetSizeHint(view, PUGL_MIN_ASPECT, 1, 1);
diff --git a/doc/c/world.rst b/doc/c/world.rst
index 83d9dbd..dcebba0 100644
--- a/doc/c/world.rst
+++ b/doc/c/world.rst
@@ -31,13 +31,13 @@ For example, Vulkan requires thread support:
PuglWorld* world = puglNewWorld(PUGL_MODULE, PUGL_WORLD_THREADS)
-It is a good idea to set a class name for your project with :func:`puglSetClassName`.
+It is a good idea to set a class name for your project with :func:`puglSetWorldString`.
This allows the window system to distinguish different applications and,
for example, users to set up rules to manage their windows nicely:
.. code-block:: c
- puglSetClassName(world, "MyAwesomeProject")
+ puglSetWorldString(world, PUGL_CLASS_NAME, "MyAwesomeProject")
.. _setting-application-data: