File: colorspace.rst

package info (click to toggle)
pymupdf 1.21.1%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 13,404 kB
  • sloc: python: 8,737; makefile: 8
file content (43 lines) | stat: -rw-r--r-- 957 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.. include:: header.rst

.. _Colorspace:

================
Colorspace
================

Represents the color space of a :ref:`Pixmap`.


**Class API**

.. class:: Colorspace

   .. method:: __init__(self, n)

      Constructor

      :arg int n: A number identifying the colorspace. Possible values are :data:`CS_RGB`, :data:`CS_GRAY` and :data:`CS_CMYK`.

   .. attribute:: name

      The name identifying the colorspace. Example: *fitz.csCMYK.name = 'DeviceCMYK'*.

      :type: str

   .. attribute:: n

      The number of bytes required to define the color of one pixel. Example: *fitz.csCMYK.n == 4*.

      :type: int


    **Predefined Colorspaces**

    For saving some typing effort, there exist predefined colorspace objects for the three available cases.

    * :data:`csRGB`  = *fitz.Colorspace(fitz.CS_RGB)*
    * :data:`csGRAY` = *fitz.Colorspace(fitz.CS_GRAY)*
    * :data:`csCMYK` = *fitz.Colorspace(fitz.CS_CMYK)*

.. include:: footer.rst