sphinx.util.png

module documentation

PNG image manipulation helpers.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Constant DEPTH​_CHUNK​_LEN Undocumented
Constant DEPTH​_CHUNK​_START Undocumented
Constant IEND​_CHUNK Undocumented
Constant LEN​_DEPTH Undocumented
Constant LEN​_IEND Undocumented
Function read​_png​_depth Read the special tEXt chunk indicating the depth from a PNG file.
Function write​_png​_depth Write the special tEXt chunk indicating the depth to a PNG file.
DEPTH_CHUNK_LEN =

Undocumented

Value
struct.pack('!i', 10)
DEPTH_CHUNK_START: bytes =

Undocumented

Value
b'tEXtDepth\x00'
IEND_CHUNK: bytes =

Undocumented

Value
b'\x00\x00\x00\x00IEND\xaeB`\x82'
LEN_DEPTH: int =

Undocumented

Value
22
LEN_IEND: int =

Undocumented

Value
12
def read_png_depth(filename):
Read the special tEXt chunk indicating the depth from a PNG file.
Parameters
filename:strUndocumented
Returns
Optional[int]Undocumented
def write_png_depth(filename, depth):

Write the special tEXt chunk indicating the depth to a PNG file.

The chunk is placed immediately before the special IEND chunk.

Parameters
filename:strUndocumented
depth:intUndocumented