summaryrefslogtreecommitdiff
path: root/man/XpmCreateBuffer.man
diff options
context:
space:
mode:
Diffstat (limited to 'man/XpmCreateBuffer.man')
-rw-r--r--man/XpmCreateBuffer.man7
1 files changed, 4 insertions, 3 deletions
diff --git a/man/XpmCreateBuffer.man b/man/XpmCreateBuffer.man
index cd3062b..44c0063 100644
--- a/man/XpmCreateBuffer.man
+++ b/man/XpmCreateBuffer.man
@@ -58,18 +58,19 @@ The XpmCreateBufferFromPixmap function works as XpmWriteFileFromPixmap(), it jus
XpmCreateBufferFromImage instead of XpmWriteFileFromImage. Once again, the caller should free the buffer using
XpmFree when finished.
-As a convenience, the XpmReadFileToBuffer and XpmWriteFileFromBuffer are provided to copy a file to a buffer
+As a convenience, the XpmReadFileToBuffer and XpmWriteFileFromBuffer functions
+are provided to copy a file to a buffer
and to write a file from a buffer. Thus for instance one may decide to use XpmReadFileToBuffer,
XpmCreatePixmapFromBuffer, and XpmFree instead of XpmReadFileToPixmap. On some systems this may lead to a
performance improvement, since the parsing will be performed in memory, but it uses more memory.
.SS XpmCreateBufferFromImage
-The XpmCreateBufferFromImage works as XpmWriteFileFromImage(), it just writes to a malloc’ed buffer instead of to a file.
+The XpmCreateBufferFromImage function works as XpmWriteFileFromImage(), it just writes to a malloc’ed buffer instead of to a file.
The caller should free the buffer using XpmFree when finished.
.SS XpmCreateBufferFromXpmImage.
To create an XPM buffer from an XpmImage, use XpmCreateBufferFromXpmImage.
-The XpmCreateBufferFromXpmImage writes out the givenimage to a single block malloc’ed buffer inXPM format.
+The XpmCreateBufferFromXpmImage function writes out the givenimage to a single block malloc’ed buffer inXPM format.
If insufficient working storage is allocated, it returns XpmNoMemory, and returns XpmSuccess on success.
If the passed XpmInfo structure pointer is not NULL, XpmCreateBufferFromXpmImage looks for the following
attributes: XpmComments, XpmExtensions, and XpmHotspot, and writes the related information out as well.