Wiki Page Content

Differences between revisions 1 and 10 (spanning 9 versions)
Revision 1 as of 2010-06-07 01:25:43
Size: 914
Editor: SheenaSmith
Comment: create page, add content (Wed Mar 10 ver; changeset 4428)
Revision 10 as of 2014-10-12 15:59:30
Size: 1442
Editor: urkle
Comment: it's a readwrite buffer
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||
Line 6: Line 5:
Use this function to create [[SDL_RWops]] structures from memory. Use this function to prepare a read-write memory buffer for use with RWops.
Line 17: Line 16:
||'''mem'''||^a pointer to the memory location containing the information to fill an [[SDL_RWops]] structure with^||
||'''size'''||^the size of the memory location^ ???||
||'''mem'''||a pointer to a buffer to feed an [[SDL_RWops]] stream||
||'''size'''||the buffer size, in bytes||
Line 21: Line 20:
A pointer to the [[SDL_RWops]] structure that is created. Returns a pointer to a new [[SDL_RWops]] structure, or NULL if it fails; call [[SDL_GetError]]() for more information.
Line 25: Line 24:
You can add your code example here char bitmap[310000];
SDL_RWops *rw = SDL_RWFromMem(bitmap, sizeof(bitmap));
SDL_SaveBMP_RW(screen, rw, 1); /* closes RWOPS, leaves us memory buffer of data */
Line 29: Line 30:
''You can add useful comments here'' This function sets up an [[SDL_RWops]] struct based on a memory area of a certain size, for both read and write access.

This memory buffer is not copied by the RWops; the pointer you provide must remain valid until you close the stream. Closing the stream will not free the original buffer.

If you need to make sure the RWops never writes to the memory buffer, you should use [[SDL_RWFromConstMem]] with a read-only buffer of memory instead.
Line 32: Line 37:
 .[[SDL_RWFromConstMem]] ???
 .[[SDL_RWFromFile]] ???
 .[[SDL_RWFromFP]] ???
 .[[SDL_RWFromConstMem]]
 .[[SDL_RWclose]]
 .[[SDL_RWread]]
.[[SDL_RWwrite]]
 .[[SDL_RWseek]]
 .[[SDL_RWtell]]

SDL_RWFromMem

Use this function to prepare a read-write memory buffer for use with RWops.

Syntax

SDL_RWops* SDL_RWFromMem(void* mem,
                         int   size)

Function Parameters

mem

a pointer to a buffer to feed an SDL_RWops stream

size

the buffer size, in bytes

Return Value

Returns a pointer to a new SDL_RWops structure, or NULL if it fails; call SDL_GetError() for more information.

Code Examples

char bitmap[310000];
SDL_RWops *rw = SDL_RWFromMem(bitmap, sizeof(bitmap));
SDL_SaveBMP_RW(screen, rw, 1);  /* closes RWOPS, leaves us memory buffer of data */

Remarks

This function sets up an SDL_RWops struct based on a memory area of a certain size, for both read and write access.

This memory buffer is not copied by the RWops; the pointer you provide must remain valid until you close the stream. Closing the stream will not free the original buffer.

If you need to make sure the RWops never writes to the memory buffer, you should use SDL_RWFromConstMem with a read-only buffer of memory instead.


CategoryAPI, CategoryIO

None: SDL_RWFromMem (last edited 2015-06-20 20:00:06 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit