|
Size: 1243
Comment:
|
Size: 1333
Comment: content entered
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 6: | Line 6: |
| Use this function to /insert short function description here/. | Use this function to lock a portion of the texture for pixel access. |
| Line 28: | Line 28: |
| A value returned by SDL_FunctionName | 0 on success, or -1 if the texture is not valid or was created with SDL_TEXTUREACCESS_STATIC |
| Line 39: | Line 39: |
| [[SDL_OtherFunction]] | [[SDL_DirtyTexture()]] [[SDL_UnlockTexture()]] |
SDL_LockTexture
Use this function to lock a portion of the texture for pixel access.
Contents
Syntax
int SDL_LockTexture (SDL_TextureID textureID,
const SDL_Rect* rect,
int markDirty,
void** pixels,
int* pitch)
Function Parameters
textureID |
The texture to lock for access, which was created with SDL_TEXTUREACCESS_STREAMING. |
rect |
A pointer to the rectangle to lock for access. If the rect is NULL, the entire texture will be locked. |
markDirty |
If this is nonzero, the locked area will be marked dirty when the texture is unlocked. |
pixels |
This is filled in with a pointer to the locked pixels, appropriately offset by the locked area. |
pitch |
This is filled in with the pitch of the locked pixels. |
Return Value
0 on success, or -1 if the texture is not valid or was created with SDL_TEXTUREACCESS_STATIC
Code Examples
You can add your code example here
Remarks
You can add useful comments here
