Renamed refresh_rate to refresh_style, a change that began in R7 but wasn't fully integrated throughout the paper until now.

Author: mikebmcl

source/history.tex

@@ -67,6 +67,9 @@
 \pnum
 Eliminated all \tcode{flush} and \tcode{mark_dirty} member functions. These only existed to allow users to modify surfaces externally. Implementations that wish to allow users to modify surfaces externally should provide and document their own functionality for how to do that. The errors, etc., are all implementation dependent anyway so a uniform calling interface provides no benefit at all in the current templated-design.
 
+\pnum
+Renamed \tcode{enum class refresh_rate} to \tcode{refresh_style} to more accurately reflect its meaning. This was already done in parts of the R7; it is now complete.
+
 \rSec1 [\iotwod.revisionhistory.r7] {Revision 7}
 
 \pnum

source/output-surface.tex

@@ -242,7 +242,7 @@
 \begin{enumerate}
 \item Handle any implementation and host environment matters. If there are no pending implementation or host environment matters to handle, proceed immediately to the next action.
 \item Run the size change callback if doing so is required by its specification and it does not have a value equivalent to its default value.
-\item If the refresh rate requires that the draw callback be called then:
+\item If the refresh style requires that the draw callback be called then:
 \begin{enumeratea}
 \item Evaluate auto clear and perform the actions required by its specification, if any.
 \item Run the draw callback.

source/refresh-rate.tex

@@ -1,28 +1,28 @@
 %!TEX root = io2d.tex
-\rSec0 [\iotwod.refreshrate] {Enum class \tcode{refresh_rate}}
+\rSec0 [\iotwod.refreshstyle] {Enum class \tcode{refresh_style}}
 
-\rSec1 [\iotwod.refreshrate.summary] {\tcode{refresh_rate} summary}
+\rSec1 [\iotwod.refreshstyle.summary] {\tcode{refresh_style} summary}
 
 \pnum
-The \tcode{refresh_rate} enum class describes when the \term{draw callback} (Table~\ref{tab:\iotwod.displaysurface.state.listing}) of a \tcode{display_surface} object shall be called. See Table~\ref{tab:\iotwod.refreshrate.meanings} for the meaning of each \tcode{} enumerator.
+The \tcode{refresh_style} enum class describes when the \term{draw callback} (Table~\ref{tab:\iotwod.displaysurface.state.listing}) of a \tcode{display_surface} object shall be called. See Table~\ref{tab:\iotwod.refreshstyle.meanings} for the meaning of each \tcode{refresh_style} enumerator.
 
-\rSec1 [\iotwod.refreshrate.synopsis] {\tcode{refresh_rate} synopsis}
+\rSec1 [\iotwod.refreshstyle.synopsis] {\tcode{refresh_style} synopsis}
 
 \begin{codeblock}
 namespace std::experimental::io2d::v1 {
-  enum class refresh_rate {
+  enum class refresh_style {
     as_needed,
     as_fast_as_possible,
     fixed
   };
 }
 \end{codeblock}
 
-\rSec1 [\iotwod.refreshrate.enumerators] {\tcode{refresh_rate} enumerators}
+\rSec1 [\iotwod.refreshstyle.enumerators] {\tcode{refresh_style} enumerators}
 
 \begin{libreqtab2}
- {\tcode{refresh_rate} value meanings}
- {tab:\iotwod.refreshrate.meanings}
+ {\tcode{refresh_style} value meanings}
+ {tab:\iotwod.refreshstyle.meanings}
  \\ \topline
  \lhdr{Enumerator}
  & \rhdr{Meaning}
@@ -39,10 +39,10 @@
  \begin{note}
  The intention of this enumerator is that implementations will call the draw callback as little as possible in order to minimize power usage. Users can call \tcode{display_surface::redraw_required} to make the implementation run the draw callback whenever the user requires.
  \end{note}
- \\
+ \\ \rowsep
  \tcode{as_fast_as_possible}
  & The draw callback shall be called as frequently as possible, subject to any limits of the execution environment.
- \\
+ \\ \rowsep
  \tcode{fixed}
  & The draw callback shall be called as frequently as needed to maintain the \term{desired frame rate} (Table~\ref{tab:\iotwod.displaysurface.state.listing}) as closely as possible. If more time has passed between two successive calls to the draw callback than is required, it shall be called \term{excess time} and it shall count towards the \term{required time}, which is the time that is required to pass after a call to the draw callback before the next successive call to the draw callback shall be made. If the excess time is greater than the required time, implementations shall call the draw callback and then repeatedly subtract the required time from the excess time until the excess time is less than the required time. If the implementation needs to call the draw callback for some other reason, it shall use that call as the new starting point for maintaining the desired frame rate.
  \begin{example}

source/surface.tex

@@ -398,13 +398,13 @@
 	If \tcode{true} the implementation shall call \tcode{clear}, which shall clear the back buffer, immediately before it executes the draw callback &
 	\tcode{false} \\ \rowsep
 
-	\term{Refresh rate} &
-	\tcode{refresh_rate} &
-	The \tcode{refresh_rate} value that determines when the draw callback shall be called while output surface\tcode{::show} is being executed &
-	\tcode{refresh_rate::as_fast_as_possible} \\ \rowsep
+	\term{Refresh style} &
+	\tcode{refresh_style} &
+	The \tcode{refresh_style} value that determines when the draw callback shall be called while \tcode{basic_output_surface<T>::begin_show} is being executed &
+	\tcode{refresh_style::as_fast_as_possible} \\ \rowsep
 
 	\term{Desired frame rate} &
 	\tcode{float} &
-	This value is the number of times the draw callback shall be called per second while output surface\tcode{::show} is being executed when the value of refresh rate is \tcode{refresh_rate::fixed}, subject to the additional requirements documented in the meaning of \tcode{refresh_rate::fixed} (Table~\ref{tab:\iotwod.refreshrate.meanings}) \\ \rowsep
-	
+	This value is the number of times the draw callback shall be called per second while \tcode{basic_output_surface<T>::begin_show} is being executed when the value of refresh style is \tcode{refresh_style::fixed}, subject to the additional requirements documented in the meaning of \tcode{refresh_style::fixed} (Table~\ref{tab:\iotwod.refreshstyle.meanings})
+	\\
 \end{libreqtab4b}