update README after renaming image_t to bopti_image_t

This commit is contained in:
Lephenixnoir 2020-09-07 19:57:29 +02:00
parent f03580ab43
commit d71e94855b
Signed by: Lephenixnoir
GPG Key ID: 1BBA026E13FC0495
1 changed files with 5 additions and 5 deletions

View File

@ -14,17 +14,17 @@ This library contains a variety of functions to perform blending, geometric and
This library has been developed for [gint](/Lephenixnoir/gint), though only two VRAM-related functions are specific to gint. I'm willing to help port it to libfxcg if anyone wants to do that.
## Differences between img_t and image_t
## Differences between img_t and bopti_image_t
The type of images in this library is called `img_t`. It is **not the same as `image_t`** (and `image_t` is the one that should be renamed to avoid the confusion).
The type of images in this library is called `img_t`. It is **not the same as `bopti_image_t`**.
* `image_t` objects are used by a gint component called *bopti* which specializes in maximizing rendering performance. They are very fast, especially on fx-9860G, but not flexible. They should probably be called `bopti_image_t`.
* `bopti_image_t` objects are used by a gint component called *bopti* which specializes in maximizing rendering performance. They are very fast, especially on fx-9860G, but not flexible.
* `img_t` objects are part of *libimg*. They're not rendered as fast, but they are more versatile and can be transformed in many ways.
There is no function to convert between `image_t` and `img_t`. Both types of images are generated by fxconv at compile time. In the unlikely event that an image needs to be available in both formats, the proper way is to convert it twice with different parameters. But normally, only one format is needed:
There is no function to convert between `bopti_image_t` and `img_t`. Both types of images are generated by fxconv at compile time. In the unlikely event that an image needs to be available in both formats, the proper way is to convert it twice with different parameters. But normally, only one format is needed:
* If the image needs to be read or transformed, use libimg. Set the fxconv parameters of the resource to `type:libimg-image` and declare it as `extern img_t myimage`.
* Otherwise, bopti should be used for maximum performance. Set the fxconv parameters to `type:bopti_image` and declare it as `extern image_t myimage`.
* Otherwise, bopti should be used for maximum performance. Set the fxconv parameters to `type:bopti_image` and declare it as `extern bopti_image_t myimage`.
## Compiling libimg