tivars.types.picture.TIImage

class documentation

class TIImage(PictureEntry): (source)

Constructor: TIImage(init, for_flash, name, version, ...)

Parser for color images

A TIImage is a 133 x 83 grid of pixels which can take on any value in the full color space. Each pixel comprises two bytes, stored in RGB565 format; rows are stored backward.

On-calc, each pixel is duplicated in both directions to fill the screen.

Method	`__init__`	Creates an empty entry with specified meta and data values
Method	`array`	No summary
Method	`calc_data`	The data section of the entry which is loaded on-calc
Method	`data`	The entry's user data
Method	`get_min_os`	Determines the minimum OS that supports this entry's data
Method	`image_magic`	Magic identifying the file as an image
Method	`load_array`	Loads a two-dimensional sequence of pixels into this picture
Method	`name`	The name of the entry
Class Variable	`data_width`	Undocumented
Class Variable	`extensions`	The file extension used for this entry per-model
Class Variable	`flash_only`	Whether this entry only supports flash chips
Class Variable	`height`	The height of the picture
Class Variable	`leading_data_bytes`	Bytes that always begin this entry's data
Class Variable	`leading_name_byte`	Byte that always begins the name of this entry
Class Variable	`min_data_length`	The minimum length of this entry's data
Class Variable	`np_shape`	The shape of this image as a NumPy array
Class Variable	`pil_mode`	The mode used by PIL images for this image type
Class Variable	`versions`	The possible versions of this entry
Class Variable	`width`	The width of the picture
Class Variable	`_type_id`	Undocumented

Inherited from PictureEntry:

Method	`__iter__`	No summary
Method	`coerce`	Coerces this entry to a subclass if possible using the entry's type ID
Class Variable	`has_color`	Whether this picture has color
Class Variable	`pixel_type`	The type of a single pixel

Inherited from SizedEntry (via PictureEntry):

Method	`clear`	Clears this entry's data
Method	`length`	The length of this entry's user data section
Method	`load_bytes`	Loads a byte string or bytestream into this entry
Method	`load_data_section`	Loads the data of this entry from a bytestream

Inherited from TIEntry (via PictureEntry, SizedEntry):

Class	`Raw`	Raw bytes container for `TIEntry`
Class Method	`get`	Converts `bytes` -> `TIEntry`
Class Method	`get_type`	Gets the subclass corresponding to a type ID if one is registered
Class Method	`open`	Creates a new entry from a file given a filename
Class Method	`register`	Registers a subtype with this class for coercion
Class Method	`set`	Converts `TIEntry` -> `bytes`
Static Method	`next_entry_length`	Helper function to determine the length of the next entry in a bytestream
Method	`__bool__`	No summary
Method	`__bytes__`	No summary
Method	`__copy__`	No summary
Method	`__eq__`	Determines if two entries are the same type and have the same bytes
Method	`__format__`	Formats this entry for string representations
Method	`__len__`	No summary
Method	`__str__`	No summary
Method	`archive`	Archives this entry (if supported)
Method	`archived`	Whether the entry is archived
Method	`bytes`	The bytes contained in this entry, without any var file header or metadata.
Method	`dict`	No summary
Method	`export`	Exports this entry to a `TIVar` with a specified name, header, and target model
Method	`get_version`	Determines the version byte corresponding to given data for this entry type
Method	`load_dict`	Loads this entry from a JSON dictionary representation
Method	`load_from_file`	Loads this entry from a file given a file pointer and offset
Method	`load_string`	Loads this entry from a string representation
Method	`meta_length`	The length of the meta section of the entry
Method	`save`	Saves this entry as a var file in the current directory given a filename and optional header and targeted model
Method	`string`	No summary
Method	`supported_by`	Determines whether a given model can support this entry
Method	`type_id`	The type ID of the entry
Method	`unarchive`	Unarchives this entry (if supported)
Method	`version`	The version number of the entry
Class Variable	`base_meta_length`	Undocumented
Class Variable	`flash_meta_length`	Undocumented
Instance Variable	`raw`	Undocumented
Property	`calc_data_length`	The length of the data section of the entry
Property	`flash_bytes`	The flash bytes of this entry if they exist
Property	`is_empty`	Whether this entry's data is empty
Property	`meta`	The meta section of this entry
Method	`__init_subclass__`	Undocumented
Constant	`_T`	Undocumented
Class Variable	`_type_ids`	Undocumented

Inherited from Dock (via PictureEntry, SizedEntry, TIEntry):

Method	`load`	Loads data into an instance by delegating to `Loader` methods based on the input's type
Class Variable	`loaders`	Undocumented

def __init__(self, init=None, *, for_flash: bool = True, name: str = 'Image1', version: int = None, archived: bool = True, data: bytes = None): (source) ¶

overrides tivars.var.TIEntry.__init__

Creates an empty entry with specified meta and data values

The entry version and archived flag are invalid if for_flash == False.

Parameters
init	Values to initialize the entry's data (defaults to `None`)
for_flash:`bool`	Whether the entry supports flash chips (defaults to `True`)
name:`str`	The name of the entry (defaults to a valid default name)
version:`int`	The entry's version (defaults to `None`)
archived:`bool`	Whether the entry is archived (defaults to entry's default state on-calc)
data:`bytes`	The entry's data (defaults to empty)

def array(self) -> list[list[pixel_type]]: (source) ¶

overrides tivars.types.picture.PictureEntry.array

Returns
`list[list[pixel_type]]`	A two-dimensional `list` of the pixels in this picture

@Section()
def calc_data(self) -> bytes: (source) ¶

overrides tivars.var.SizedEntry.calc_data

The data section of the entry which is loaded on-calc

@View(calc_data, SizedData)[3:]
def data(self) -> bytes: (source) ¶

overrides tivars.var.SizedEntry.data

The entry's user data

def get_min_os(self, data: bytes = None) -> OsVersion: (source) ¶

overrides tivars.var.TIEntry.get_min_os

Determines the minimum OS that supports this entry's data

Parameters
data:`bytes`	The data to find the minimum support for (defaults to this entry's data)
Returns
`OsVersion`	The minimum `OsVersion` this entry supports