https://github.com/humansinput/txcairo
Image rendering module for TXLin implemented using Cairo graphics library.
https://github.com/humansinput/txcairo
cairo cplusplus cpp linux macos sdl2 txlib txlin txlin-module
Last synced: 30 days ago
JSON representation
Image rendering module for TXLin implemented using Cairo graphics library.
- Host: GitHub
- URL: https://github.com/humansinput/txcairo
- Owner: humansinput
- Created: 2019-11-06T16:38:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-11-11T16:17:00.000Z (over 5 years ago)
- Last Synced: 2025-05-07T09:12:03.060Z (about 1 month ago)
- Topics: cairo, cplusplus, cpp, linux, macos, sdl2, txlib, txlin, txlin-module
- Language: C
- Size: 3.91 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.asciidoc
Awesome Lists containing this project
README
= TXCairo
**TXCairo** is a module adding image loading and blitting support to TXLin. This module is implemented using Cairo (hence the name).
== Installation (on macOS)
Install Cairo via MacPorts:
[source,bash]
----
$ sudo port install cairo
$ sudo port deactivate libiconv -f # this needs to be done ONLY if you've been using the installer
----
Copy the header into ``/Library/Developer/TXLin/include``:
[source,bash]
----
$ sudo cp TXCairo.h /Library/Developer/TXLin/include/
----
== Installation (on Linux)
Install Cairo:
[source,bash]
----
$ sudo apt-get install libcairo2-dev -y
----
Copy TXCairo.h into ``/usr/include``:
[source,bash]
----
$ sudo cp TXCairo.h /usr/include/
----
== Usage
**CURRENTLY, ONLY PNG IMAGES ARE SUPPORTED**
There is one function responsible for loading PNGs and rendering them - ``txBlitPNG``.
Declaration:
[source,c++]
----
bool txBlitPNG(const char* pngIn, HDC dcOut = txDC(), unsigned x = 0, unsigned y = 0)
----
**Arguments:**
[squares]
- ``const char* pngIn`` - full path to the PNG file to be loaded. Example: ``/Users/tim/Pictures/cats/maru.png``.
- ``HDC dcOut`` (_optional_) - the surface descriptor pointing to the surface where the picture shall be rendered.
- ``unsigned x`` (_optional_), ``unsigned y`` (_also optional_) - the coordinates of the top left corner of the picture on the surface.
**Returns**:
``true`` on success, ``false`` on failure.
**Example**:
See ``demo.cxx`` for an example and ``build-demo.sh`` for build instructions.
=== BMP support
There is a function for that, too:
[source,c++]
----
bool txBlitBMP(const char* bmpIn, HDC dcOut = txDC(), unsigned x = 0, unsigned y = 0)
----
**Arguments:**
[squares]
- ``const char* bmpIn`` - full path to the BMP file to be loaded.
- ``HDC dcOut`` (_optional_) - the surface descriptor pointing to the surface where the picture shall be rendered.
- ``unsigned x`` (_optional_), ``unsigned y`` (_also optional_) - the coordinates of the top left corner of the picture on the surface.
**Returns**:
``true`` on success, ``false`` on failure.
== License
TXLin License: http://meow.roveramd.com/archives/LICENSE.TXLIN