implement standard font tests for Imager::Font::W32

[imager.git] / lib / Imager / API.pod

diff --git a/lib/Imager/API.pod b/lib/Imager/API.pod
index 7cb5d25b7605450ab2f4675be70a7b9886a1ca53..2f49ef5a06dd96d5ef23c1b49832d54826302b4e 100644 (file)
--- a/lib/Imager/API.pod
+++ b/lib/Imager/API.pod
@@ -419,7 +419,7 @@ simple mutex functions.
 
 To create a mutex:
 
-  i_mutex_t m = i_mutex_create();
+  i_mutex_t m = i_mutex_new();
 
 To control or lock the mutex:
 
@@ -437,6 +437,34 @@ I most cases where you'd use these functions, your code would create
 the mutex in your BOOT section, then lock and unlock the mutex as
 needed to control access to the library.
 
+=head1 Context slots
+
+=for stopwords
+TLS APIs
+
+To avoid abstracting the platform TLS and thread clean up handling,
+Imager provides simple APIs for storing per-context information.
+
+To allocate a slot:
+
+  im_slot_t slot = im_context_slot_new(callback)
+
+where callback is a (possibly NULL) function pointer called when the
+context object is destroyed.
+
+By default, the stored value for a slot is NULL, whether for a new
+context or for a cloned context.
+
+To store a value:
+
+  im_context_slot_set(aIMCTX, slot, somevalue);
+
+where C<somevalue> can be represented as a C<void *>.
+
+To retrieve the value:
+
+  value = im_context_slot_get(aIMCTX, slot);
+
 =head1 AUTHOR
 
 Tony Cook <tonyc@cpan.org>