|
Size: 1182
Comment: update content - pointers, structs
|
← Revision 6 as of 2015-12-19 22:25:09 ⇥
Size: 865
Comment: Fixed Syntax section, see SGFunctions.
|
| 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 write an item of native format to the specified endianness. <<Color2(green,This is the generalized description from the header. Should it be adjusted to be specific for each function for the wiki? ie: Use this function to write an item of native format to little-endian format.)>> |
Use this function to write 16 bits in native format to a [[SDL_RWops]] as little-endian data. |
| Line 19: | Line 16: |
| ||'''dst'''||^the SDL_RWops structure to be filled^|| ||'''value'''||^the data to write as little-endian^|| |
||'''dst'''||the stream to which data will be written|| ||'''value'''||the data to be written, in native format|| |
| Line 23: | Line 20: |
| The size (in bytes) of the data that was written, or 0 for error; call [[SDL_GetError]]() for more information. | Returns 1 on successful write, 0 on error. |
| Line 31: | Line 28: |
| ''You can add useful comments here'' | SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in little-endian format. |
| Line 35: | Line 32: |
| <<Color2(green,Should the other Read functions and/or the Write functions be listed here?)>> |
SDL_WriteLE16
Use this function to write 16 bits in native format to a SDL_RWops as little-endian data.
Contents
Syntax
size_t SDL_WriteLE16(SDL_RWops* dst,
Uint16 value)
Function Parameters
dst |
the stream to which data will be written |
value |
the data to be written, in native format |
Return Value
Returns 1 on successful write, 0 on error.
Code Examples
You can add your code example here
Remarks
SDL byteswaps the data only if necessary, so the application always specifies native format, and the data written will be in little-endian format.
