mirror of
https://github.com/SFML/SFML.git
synced 2024-11-24 20:31:05 +08:00
Add clarification about the RenderTexture state after creation
This commit is contained in:
parent
b7e1a259f0
commit
1a4003fcc0
@ -72,11 +72,15 @@ public:
|
||||
/// Before calling this function, the render-texture is in
|
||||
/// an invalid state, thus it is mandatory to call it before
|
||||
/// doing anything with the render-texture.
|
||||
///
|
||||
/// The last parameter, \a depthBuffer, is useful if you want
|
||||
/// to use the render-texture for 3D OpenGL rendering that requires
|
||||
/// a depth buffer. Otherwise it is unnecessary, and you should
|
||||
/// leave this parameter to false (which is its default value).
|
||||
///
|
||||
/// After creation, the contents of the render-texture are undefined.
|
||||
/// Call `RenderTexture::clear` first to ensure a single color fill.
|
||||
///
|
||||
/// \param width Width of the render-texture
|
||||
/// \param height Height of the render-texture
|
||||
/// \param depthBuffer Do you want this render-texture to have a depth buffer?
|
||||
@ -94,11 +98,15 @@ public:
|
||||
/// Before calling this function, the render-texture is in
|
||||
/// an invalid state, thus it is mandatory to call it before
|
||||
/// doing anything with the render-texture.
|
||||
///
|
||||
/// The last parameter, \a settings, is useful if you want to enable
|
||||
/// multi-sampling or use the render-texture for OpenGL rendering that
|
||||
/// requires a depth or stencil buffer. Otherwise it is unnecessary, and
|
||||
/// you should leave this parameter at its default value.
|
||||
///
|
||||
/// After creation, the contents of the render-texture are undefined.
|
||||
/// Call `RenderTexture::clear` first to ensure a single color fill.
|
||||
///
|
||||
/// \param width Width of the render-texture
|
||||
/// \param height Height of the render-texture
|
||||
/// \param settings Additional settings for the underlying OpenGL texture and context
|
||||
|
Loading…
Reference in New Issue
Block a user