summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/l3kernel/l3drivers.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/l3kernel/l3drivers.dtx')
-rw-r--r--Master/texmf-dist/source/latex/l3kernel/l3drivers.dtx54
1 files changed, 53 insertions, 1 deletions
diff --git a/Master/texmf-dist/source/latex/l3kernel/l3drivers.dtx b/Master/texmf-dist/source/latex/l3kernel/l3drivers.dtx
index 352eb9a149c..24f7ad3eb9b 100644
--- a/Master/texmf-dist/source/latex/l3kernel/l3drivers.dtx
+++ b/Master/texmf-dist/source/latex/l3kernel/l3drivers.dtx
@@ -43,7 +43,7 @@
% }^^A
% }
%
-% \date{Released 2019-05-07}
+% \date{Released 2019-05-09}
%
% \maketitle
%
@@ -463,6 +463,58 @@
% given.
% \end{function}
%
+% \section{Graphics inclusion}
+%
+% Graphics inclusion support is closely tied to the higher-level \pkg{l3graphics}
+% module. This arises as information concerning images (\emph{e.g.}~page
+% numbers in multi-page files) is needed to correct cache image data. As
+% such, the driver code here assumes the following are defined
+% \begin{itemize}
+% \item \cs{l_image_decodearray_tl}
+% \item \cs{l_image_interpolate_tl}
+% \item \cs{l_image_page_tl}
+% \item \cs{l_image_pagebox_tl}
+% \end{itemize}
+%
+% Note also that the functions defined will depend on the file types supported
+% by the driver. As such, a calling function should typically test for the
+% existence of an appropriate function to determine if the image file is
+% supported.
+%
+% \begin{function}[added = 2019-05-07]
+% {
+% \driver_graphics_getbb_eps:n,
+% \driver_graphics_getbb_jpg:n,
+% \driver_graphics_getbb_pdf:n,
+% \driver_graphics_getbb_png:n
+% }
+% \begin{syntax}
+% \cs{driver_graphics_getbb_pdf:n} \Arg{file}
+% \end{syntax}
+% These functions load the requested image \meta{file} and obtain the
+% bounding box information on the file. They may also cache the image for
+% subsequent inclusion: this is driver-dependent. The bounding box data
+% will be stored in \cs{l_image_llx_dim}, \cs{l_image_lly_dim},
+% \cs{l_image_urx_dim}, and \cs{l_image_ury_dim} after use of these
+% functions.
+% \end{function}
+%
+% \begin{function}[added = 2019-05-07]
+% {
+% \driver_graphics_include_eps:n,
+% \driver_graphics_include_jpg:n,
+% \driver_graphics_include_pdf:n,
+% \driver_graphics_include_png:n
+% }
+% \begin{syntax}
+% \cs{driver_graphics_include_pdf:n} \Arg{file}
+% \end{syntax}
+% These functions include the appropriate image type at the current position.
+% They should be preceded by use of the matching \texttt{getbb} function to
+% set the bounding box correctly; in some drivers, the \texttt{getbb}
+% function is also responsible for caching the image for later inclusion.
+% \end{function}
+%
% \section{PDF Features}
%
% A range of PDF features are exposed by \pdfTeX{} and \LuaTeX{} in direct PDF