Skip to main content

3DN BIP allows blazingly fast image loads in Blender.

Project description

3D Ninjas | Blender Image Preview (BIP) Library

Documentation

  1. Getting Started (this page)
  2. Install Pillow
  3. Reference
  4. More
  5. Development

What is 3DN BIP?

3DN BIP or 3D Ninjas Blender Image Preview is a library, which allows blazingly fast preview image loads in Blender. Furthermore, it can load preview images of arbitrary size. It operates as an bpy.utils.previews drop-in replacement and does all the heavy lifting for you.

Our library enables the following major use cases:

  1. Load preview images shipped as BIP images blazingly fast. We recommend this approach in case you can generate the images beforehand. In this case, your users don't need to take any action to enjoy the speed boost.
  2. Load regular JPEG or PNG preview images blazingly fast. Recommended in case you need to load images provided by the user or by external software tools. For that, we need Pillow on the user's system. It would be best if you use our prepared InstallPillow operator so that your users can enjoy the speed boost with a simple click.

Notes:

  1. Our library will always fall back to bpy.utils.previews if unsupported formats are to be loaded. For this reason, there is absolutely no disadvantage in using this library. In the worst case, we will apply the standard mechanism of Blender.
  2. .bip is a highly optimized image format, which can be transferred to Blender's internal data structures immediately. It is always blazingly fast, whether Pillow is installed or not.

Examples

Download the following sample addons. You can easily install the ZIP files in Blender via the addon preferences tab.

Library

The latest release of the library can be downloaded here: t3dn_bip.zip

Just extract the zip file and copy the folder into your addon. Take a closer look at the examples given above to learn how to use the library.

In case you want to install the library via PyPI, you can use the following command:

python -m pip install t3dn-bip

Converter

The converter is provided via PyPI. Use the following command for the installation:

python -m pip install t3dn-bip-converter

Use the following command to convert images of various formats into the BIP format:

python -m t3dn_bip_converter source_file.png destination_file.bip

Showcases

Show .bip and .jpg Images

Show .bip and .jpg Images in an Enum

Show large .bip and .jpg Hero Images

Show .bip and .png Images with an Alpha Channel

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

t3dn-bip-1.0.7.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

t3dn_bip-1.0.7-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file t3dn-bip-1.0.7.tar.gz.

File metadata

  • Download URL: t3dn-bip-1.0.7.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5

File hashes

Hashes for t3dn-bip-1.0.7.tar.gz
Algorithm Hash digest
SHA256 1fba93aff7f8afb2887b309d39517cb35ef740baa7067ec174ccf18bc4d19e63
MD5 51c0dca4c80a2dc89ccba3279b6595c0
BLAKE2b-256 ac898c91fc55e9e620dcd8c2e14caeb78752a7bf6969349aa38c5799bb37ebc3

See more details on using hashes here.

File details

Details for the file t3dn_bip-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: t3dn_bip-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.5

File hashes

Hashes for t3dn_bip-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 08110148ce898fee1f8b28eaf05bc2aec162ccbc80d336f032d68202e1d7259b
MD5 ed3330fa6127b2a1ba479684b1469a2b
BLAKE2b-256 e6f197d9aaa2e9abea97396fea189c640b0f428fdcb193d591a10fa931eb0d77

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page