Wiki Page Content

Differences between revisions 14 and 15
Revision 14 as of 2009-11-25 07:12:55
Size: 1556
Editor: SheenaSmith
Comment: add categories
Revision 15 as of 2009-12-05 05:03:14
Size: 1591
Editor: SheenaSmith
Comment: content changed
Deletions are marked like this. Additions are marked like this.
Line 19: Line 19:
||'''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.||
||'''textureID'''||the texture to lock for access, which was created with SDL_TEXTUREACCESS_STREAMING||
||'''rect'''||a pointer to and [[SDL_Rect]] structure representing the area to lock for access; if the '''rect''' is NULL the entire texture will be locked||
||'''markDirty'''||if this is non-zero 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||

SDL_LockTexture

Use this function to lock a portion of the texture for pixel access.

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 and SDL_Rect structure representing the area to lock for access; if the rect is NULL the entire texture will be locked

markDirty

if this is non-zero 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 a negative error code if the texture is not valid or was created with SDL_TEXTUREACCESS_STATIC; call SDL_GetError() for more information.

Code Examples

You can add your code example here

Remarks

If you don't want to mark the entire area dirty you can pass 0 for markDirty and then use SDL_DirtyTexture() to mark specific subareas dirty.


CategoryAPI, CategoryVideo

None: SDL_LockTexture (last edited 2014-12-21 21:01:03 by PhilippWiesemann)

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