Skip to content

[Sync-En] imagick: document the image types #1286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PhilDaiguille merged 1 commit into from
Sep 8, 2026
Merged

[Sync-En] imagick: document the image types #1286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 75 additions & 2 deletions reference/imagick/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 3bbb0751e2cbb98aa239dedea41d622cf9d654aa Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: 0aa15a23a0b1457ab2545d7f38eb292fd2f4b66e Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<appendix xmlns="http://docbook.org/ns/docbook" xml:id="imagick.constants">
&reftitle.constants;
Expand Down Expand Up @@ -1029,14 +1029,36 @@
</variablelist>
<variablelist xml:id="imagick.constants.imagetype">
<title>Constantes <constant>IMGTYPE_<replaceable>*</replaceable></constant></title>
<para></para>
<simpara>
Un tipo de imagen combina un modelo de color con la presencia o ausencia de
un canal alfa.
Pasar una de estas constantes a
<methodname>Imagick::setImageType</methodname> convierte la imagen a ese
tipo.
<methodname>Imagick::getImageType</methodname> informa del tipo de una
imagen, pero solo devuelve un tipo que describa datos de píxeles reales,
nunca <constant>imagick::IMGTYPE_UNDEFINED</constant> ni
<constant>imagick::IMGTYPE_OPTIMIZE</constant>.
</simpara>
<simpara>
Las constantes cuyo nombre termina en <literal>MATTE</literal> son las
variantes que llevan un canal alfa; las demás no lo tienen.
En ImageMagick 6 el canal alfa se conocía como canal matte, y cuando
Imagick se compila contra ImageMagick 7 cada una de estas constantes existe
también bajo un nombre
<constant>IMGTYPE_<replaceable>*</replaceable>ALPHA</constant> con el mismo
valor.
</simpara>
<varlistentry xml:id="imagick.constants.imgtype-undefined">
<term>
<constant>imagick::IMGTYPE_UNDEFINED</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
El tipo de imagen no se conoce.
<methodname>Imagick::setImageType</methodname> no convierte nada para este
valor, pero lo registra igualmente en la imagen.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1047,6 +1069,10 @@
</term>
<listitem>
<simpara>
Solo dos colores.
La imagen se convierte a escala de grises, se estira su contraste y cada
píxel pasa a ser negro o blanco según sea más claro o más oscuro que el
gris medio; cualquier canal alfa se descarta.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1057,6 +1083,9 @@
</term>
<listitem>
<simpara>
Tonos de gris.
La imagen se convierte al espacio de color de escala de grises y cualquier
canal alfa se descarta.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1067,6 +1096,10 @@
</term>
<listitem>
<simpara>
Tonos de gris con un canal alfa.
Igual que <constant>imagick::IMGTYPE_GRAYSCALE</constant>, salvo que el
canal alfa se conserva y, si la imagen no tiene ninguno, se le añade uno
opaco.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1077,6 +1110,9 @@
</term>
<listitem>
<simpara>
Color indexado.
La imagen se convierte a sRGB y, si no está ya indexada o tiene más de 256
colores, se cuantiza a 256 colores; cualquier canal alfa se descarta.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1087,6 +1123,12 @@
</term>
<listitem>
<simpara>
Color indexado con un canal alfa.
La imagen se convierte a sRGB, el canal alfa se conserva y, si la imagen
no tiene ninguno, se le añade uno opaco.
A diferencia de <constant>imagick::IMGTYPE_PALETTE</constant>, los colores
se cuantizan incluso cuando la imagen ya está indexada, y el canal alfa se
incluye en la cuantización.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1097,6 +1139,8 @@
</term>
<listitem>
<simpara>
Color directo: un valor de rojo, verde y azul por píxel, sin paleta.
La imagen se convierte a sRGB y cualquier canal alfa se descarta.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1107,6 +1151,10 @@
</term>
<listitem>
<simpara>
Color directo con un canal alfa.
Igual que <constant>imagick::IMGTYPE_TRUECOLOR</constant>, salvo que el
canal alfa se conserva y, si la imagen no tiene ninguno, se le añade uno
opaco.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1117,6 +1165,9 @@
</term>
<listitem>
<simpara>
Un canal por tinta de impresión, sin paleta.
La imagen se convierte al espacio de color CMYK y cualquier canal alfa se
descarta.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1127,6 +1178,26 @@
</term>
<listitem>
<simpara>
Un canal por tinta de impresión, sin paleta, más un canal alfa.
Igual que <constant>imagick::IMGTYPE_COLORSEPARATION</constant>, salvo que
el canal alfa se conserva y, si la imagen no tiene ninguno, se le añade uno
opaco.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="imagick.constants.imgtype-palettebilevelmatte">
<term>
<constant>imagick::IMGTYPE_PALETTEBILEVELMATTE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Color indexado con un canal alfa totalmente transparente o totalmente
opaco.
La imagen se convierte a sRGB, se le añade un canal alfa opaco si no tiene
ninguno, ese canal por sí solo se reduce a dos valores y después se
cuantizan los colores.
Este es el tipo de un PNG que usa transparencia binaria.
</simpara>
</listitem>
</varlistentry>
Expand All @@ -1137,6 +1208,8 @@
</term>
<listitem>
<simpara>
<methodname>Imagick::setImageType</methodname> no convierte nada para este
valor, pero lo registra igualmente en la imagen.
</simpara>
</listitem>
</varlistentry>
Expand Down
126 changes: 61 additions & 65 deletions reference/imagick/imagick/getimagetype.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 65c4446ab35754d2f3cd8abec11302650a150bf9 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: 0aa15a23a0b1457ab2545d7f38eb292fd2f4b66e Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.getimagetype">
<refnamediv>
<refname>Imagick::getImageType</refname>
<refpurpose>Obtiene el tipo posible de imagen</refpurpose>
<refpurpose>Obtiene el tipo de imagen</refpurpose>
</refnamediv>

<refsect1 role="description">
Expand All @@ -15,9 +15,12 @@
<modifier>public</modifier> <type>int</type><methodname>Imagick::getImageType</methodname>
<void/>
</methodsynopsis>
<para>
Devuelve el tipo posible de imagen.
</para>
<simpara>
Devuelve el tipo de la imagen, deducido de su espacio de color, de su clase
de almacenamiento y de si lleva un canal alfa. Los píxeles en sí no se
examinan, por lo que el valor refleja cómo está representada actualmente la
imagen y no el tipo más pequeño al que podría reducirse.
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -27,66 +30,59 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Obtiene el tipo posible de imagen.
<itemizedlist>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_UNDEFINED</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_BILEVEL</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_GRAYSCALE</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_GRAYSCALEMATTE</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_PALETTE</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_PALETTEMATTE</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_TRUECOLOR</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_TRUECOLORMATTE</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_COLORSEPARATION</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_COLORSEPARATIONMATTE</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>imagick::IMGTYPE_OPTIMIZE</constant>
</simpara>
</listitem>
</itemizedlist>
</para>
<simpara>
Devuelve una de las siguientes constantes
<link linkend="imagick.constants.imagetype"><constant>imagick::IMGTYPE_<replaceable>*</replaceable></constant></link>.
<constant>imagick::IMGTYPE_UNDEFINED</constant> e
<constant>imagick::IMGTYPE_OPTIMIZE</constant> nunca se devuelven.
</simpara>
<itemizedlist>
<listitem>
<simpara>
<link linkend="imagick.constants.imgtype-bilevel"><constant>imagick::IMGTYPE_BILEVEL</constant></link>
</simpara>
</listitem>
<listitem>
<simpara>
<link linkend="imagick.constants.imgtype-grayscale"><constant>imagick::IMGTYPE_GRAYSCALE</constant></link>
</simpara>
</listitem>
<listitem>
<simpara>
<link linkend="imagick.constants.imgtype-grayscalematte"><constant>imagick::IMGTYPE_GRAYSCALEMATTE</constant></link>
</simpara>
</listitem>
<listitem>
<simpara>
<link linkend="imagick.constants.imgtype-palette"><constant>imagick::IMGTYPE_PALETTE</constant></link>
</simpara>
</listitem>
<listitem>
<simpara>
<link linkend="imagick.constants.imgtype-palettematte"><constant>imagick::IMGTYPE_PALETTEMATTE</constant></link>
</simpara>
</listitem>
<listitem>
<simpara>
<link linkend="imagick.constants.imgtype-truecolor"><constant>imagick::IMGTYPE_TRUECOLOR</constant></link>
</simpara>
</listitem>
<listitem>
<simpara>
<link linkend="imagick.constants.imgtype-truecolormatte"><constant>imagick::IMGTYPE_TRUECOLORMATTE</constant></link>
</simpara>
</listitem>
<listitem>
<simpara>
<link linkend="imagick.constants.imgtype-colorseparation"><constant>imagick::IMGTYPE_COLORSEPARATION</constant></link>
</simpara>
</listitem>
<listitem>
<simpara>
<link linkend="imagick.constants.imgtype-colorseparationmatte"><constant>imagick::IMGTYPE_COLORSEPARATIONMATTE</constant></link>
</simpara>
</listitem>
</itemizedlist>
</refsect1>

<refsect1 role="errors">
Expand Down
41 changes: 26 additions & 15 deletions reference/imagick/imagick/setimagetype.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0ffb9c9fc8f4bf1589a1a573644e1c23b6b451d1 Maintainer: seros Status: ready -->
<!-- EN-Revision: 0aa15a23a0b1457ab2545d7f38eb292fd2f4b66e Maintainer: seros Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.setimagetype">
<refnamediv>
<refname>Imagick::setImageType</refname>
Expand All @@ -13,24 +13,35 @@
<modifier>public</modifier> <type>bool</type><methodname>Imagick::setImageType</methodname>
<methodparam><type>int</type><parameter>image_type</parameter></methodparam>
</methodsynopsis>
<para>
Establece el tipo de imagen.
</para>
<simpara>
Convierte la imagen al tipo dado, que combina un modelo de color con la
presencia o ausencia de un canal alfa.
Según el tipo, esto puede cambiar el espacio de color, cuantizar los colores
o cambiar si la imagen tiene un canal alfa.
</simpara>
<simpara>
<methodname>Imagick::setImageType</methodname> modifica la propia imagen.
Para establecer en su lugar el tipo con el que se escriben las imágenes
siguientes, use <methodname>Imagick::setType</methodname>.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>image_type</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<variablelist>
<varlistentry>
<term><parameter>image_type</parameter></term>
<listitem>
<simpara>
Una de las constantes
<link linkend="imagick.constants.imagetype"><constant>imagick::IMGTYPE_<replaceable>*</replaceable></constant></link>.
<constant>imagick::IMGTYPE_UNDEFINED</constant> e
<constant>imagick::IMGTYPE_OPTIMIZE</constant> no convierten nada, pero
se registran igualmente en la imagen.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
Expand Down
Loading