Skip to content

Commit

Permalink
Improve documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mordante committed Apr 6, 2014
1 parent 345fc7f commit e1d054d
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions src/sdl/texture.hpp
Expand Up @@ -73,7 +73,7 @@ class ttexture
ttexture& operator=(const ttexture& texture);


/***** ***** ***** Members. ***** ***** *****/
/***** ***** ***** Setters and getters. ***** ***** *****/

/**
* Returns a pointer to the surface the texture was created from, if it was
Expand All @@ -96,7 +96,17 @@ class ttexture
/** The SDL_Texture we manage. */
SDL_Texture* texture_;

/** The SDL_Surface source of the texture. Probably NULL. */
/**
* The SDL_Surface source of the @ref texture_.
*
* The value of the field dependings on the constructor used:
* - Image loading:
* Depends on the @p access_mode argument:
* * SDL_TEXTUREACCESS_STATIC @c NULL.
* * SDL_TEXTUREACCESS_STREAMING the surface of the loaded image.
* - Other:
* Always @c NULL.
*/
SDL_Surface* source_surface_;
};

Expand Down

0 comments on commit e1d054d

Please sign in to comment.