gl_rasterizer: Amend documentation comment for ConfigureFramebuffers()
must_reconfigure isn't a parameter for this function any more, so it can be replaced with current_state. While we're at it, we can make the parameters of the declaration match the same name as the ones in the definition.
This commit is contained in:
parent
9e689a81f8
commit
c04785c928
1 changed files with 9 additions and 7 deletions
|
@ -98,17 +98,19 @@ private:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Configures the color and depth framebuffer states.
|
* Configures the color and depth framebuffer states.
|
||||||
* @param must_reconfigure If true, tells the framebuffer to skip the cache and reconfigure
|
*
|
||||||
* again. Used by the texture cache to solve texception conflicts
|
* @param current_state The current OpenGL state.
|
||||||
* @param use_color_fb If true, configure color framebuffers.
|
* @param using_color_fb If true, configure color framebuffers.
|
||||||
* @param using_depth_fb If true, configure the depth/stencil framebuffer.
|
* @param using_depth_fb If true, configure the depth/stencil framebuffer.
|
||||||
* @param preserve_contents If true, tries to preserve data from a previously used framebuffer.
|
* @param preserve_contents If true, tries to preserve data from a previously used
|
||||||
|
* framebuffer.
|
||||||
* @param single_color_target Specifies if a single color buffer target should be used.
|
* @param single_color_target Specifies if a single color buffer target should be used.
|
||||||
|
*
|
||||||
* @returns If depth (first) or stencil (second) are being stored in the bound zeta texture
|
* @returns If depth (first) or stencil (second) are being stored in the bound zeta texture
|
||||||
* (requires using_depth_fb to be true)
|
* (requires using_depth_fb to be true)
|
||||||
*/
|
*/
|
||||||
std::pair<bool, bool> ConfigureFramebuffers(
|
std::pair<bool, bool> ConfigureFramebuffers(
|
||||||
OpenGLState& current_state, bool use_color_fb = true, bool using_depth_fb = true,
|
OpenGLState& current_state, bool using_color_fb = true, bool using_depth_fb = true,
|
||||||
bool preserve_contents = true, std::optional<std::size_t> single_color_target = {});
|
bool preserve_contents = true, std::optional<std::size_t> single_color_target = {});
|
||||||
|
|
||||||
/// Configures the current constbuffers to use for the draw command.
|
/// Configures the current constbuffers to use for the draw command.
|
||||||
|
|
Loading…
Reference in a new issue