Skip to content

Commit cce12f3

Browse files
some more formattings and completions and questions
1 parent c0d89eb commit cce12f3

File tree

1 file changed

+30
-17
lines changed

1 file changed

+30
-17
lines changed

spec/vt-good-image-protocol.tex

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -215,12 +215,14 @@ \subsection{Upload Image}
215215

216216
Uploads an image for future render operations.
217217

218+
\subsubsection*{Parameters}
219+
218220
\begin{itemize}
219-
\item Id; a unique identifier for the uploaded image
220-
\item format; a value that determines the image format. See section \ref{sec:supported-image-formtats}
221-
\item data; image data in the given input format
222-
\item width; optional pixel width of the given image (only required for RGB/RGBA format)
223-
\item height; optional pixel height of the given image (only required for RGB/RGBA format)
221+
\item \textbf{id}; a unique identifier for the uploaded image
222+
\item \textbf{format}; a value that determines the image format. See section \ref{sec:supported-image-formtats}
223+
\item \textbf{data}; image data in the given input format
224+
\item \textbf{width}; optional pixel width of the given image (only required for RGB/RGBA format)
225+
\item \textbf{height}; optional pixel height of the given image (only required for RGB/RGBA format)
224226
\end{itemize}
225227

226228
\subsubsection{Idempotency}
@@ -285,9 +287,9 @@ \subsubsection*{Parameters}
285287
\end{itemize}
286288
\end{itemize}
287289

288-
\paragraph*{}
289-
If parameter \textbf{grid-width} and \textbf{grid-height} are both omitted (or set to 0), then the
290-
number of grid cells will be automatically determined.
290+
% \paragraph*{}
291+
% If parameter \textbf{grid-width} and \textbf{grid-height} are both omitted (or set to 0), then the
292+
% number of grid cells will be automatically determined.
291293

292294
\paragraph*{}
293295
If one of the parameters \textbf{grid-width} and \textbf{grid-height} is present and the other is
@@ -349,15 +351,17 @@ \subsection{Upload and Render Image}
349351
The image will be rendered with the top-left matching the current ANSI cursor position.
350352
The cursor will not be moved by this operation.
351353

354+
\subsubsection*{Parameters}
355+
352356
\begin{itemize}
353-
\item format; a value that determines the image format. See section \ref{sec:supported-image-formtats}
354-
\item data; image data in the given input format
355-
\item width; optional pixel width of the given image (only required for RGB/RGBA format)
356-
\item height; optional pixel height of the given image (only required for RGB/RGBA format)
357-
\item resizePolicy; optional, mandates how to resize the image within the grid cells (default NoResize)
358-
\item alignmentPolicy; optional, mandates how to align the image within the grid cells (default: MiddleCenter)
359-
\item grid-width; number of grid cells to render horizontally
360-
\item grid-height; number of grid cells to render vertically
357+
\item \textbf{format}; a value that determines the image format. See section \ref{sec:supported-image-formtats}
358+
\item \textbf{data}; image data in the given input format
359+
\item \textbf{image-width}; optional, number of pixels of the image's width to display (default: max width)
360+
\item \textbf{image-height}; optional, number of pixels of the image's height to display (default max height)
361+
\item \textbf{resize-policy}; optional, mandates how to resize the image within the grid cells (default NoResize)
362+
\item \textbf{alignment-policy}; optional, mandates how to align the image within the grid cells (default: MiddleCenter)
363+
\item \textbf{grid-width}; number of grid cells to render horizontally
364+
\item \textbf{grid-height}; number of grid cells to render vertically
361365
\end{itemize}
362366

363367
\todo{Specify how auto-scroll can be achieved in primary screen for Render and Upload-and-Render actions.}
@@ -368,8 +372,10 @@ \subsection{Release Image}
368372

369373
This will cause decrementing the use-count of the previously uploaded image.
370374

375+
\subsubsection*{Parameters}
376+
371377
\begin{itemize}
372-
\item Id; Unique identifier referencing a previously uploaded image.
378+
\item \textbf{id}; Unique identifier referencing a previously uploaded image.
373379
\end{itemize}
374380

375381
\subsection{Feature Detection}
@@ -586,6 +592,13 @@ \section{References} % {{{
586592
% }}}
587593

588594
\section{Editorial Notes}
595+
596+
\begin{itemize}
597+
\item Maybe use tables instead of lists for parameter listings?
598+
\item $0x3A$ \code{:} is not allowed in DCS, check that. Maybe all params should be name-based then ...
599+
\item Should we mention how to deal with HiDPI displays and content scaling?
600+
\end{itemize}
601+
589602
\listoftodos
590603

591604
\end{document}

0 commit comments

Comments
 (0)