stbimage 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f161bb612911051438045d1e2bbc1b9f317e9f67e4f018bb80beec9c8a63858
-  data.tar.gz: 50b048e52a2991b135f416b82ea937c8e24b0adac9f05b97bcf3509bb16b5185
+  metadata.gz: 69de01a0ee15b7dc3ce3827d250b061b62d56a3348d49b4cf01f53773439c9ab
+  data.tar.gz: bd2e49f16a3aad172a99645012af9cab9e8cde0a6cb0eef7bb8250ddd888183d
 SHA512:
-  metadata.gz: 5740266226e0fc8172979a758ecd719db09cce49bb8ded18fd43aa3001ae06d704cb2fa6606ae18342bf95c87bf2cfd544b1d74b16896a701cc7ccd7ee04e69a
-  data.tar.gz: ee86a36e31f69327aaca6d84685881134cbcad9f0f4af1ff33a6e8037e84ee70b195f1ea5d7401a7ea1dcd515ede2f29f1fe5d36cbbade529cfd666390d9eca7
+  metadata.gz: fbac49f49b65b30ff3340a8d3d8e2dbb7fb551dae3286255e8fac24282766e8fbc2d3fc9dd43c5082ef9020a0f8aded035064f884cee4e2e7618d115ab85af6c
+  data.tar.gz: 8c31f5a515a4ea94524dfcdbcee97821792655ee8c227f97dab2663ac89527d3fe8820f899aaeaafdf67253c417dee306686914527cc09256fa0220b12fcab7f

data/README.md

@@ -1,35 +1,18 @@
-# STBIMAGE     
-
-
+# stb-image ruby bindings     
 
 Ruby binding of stb-image.h
 
-**Works well on windows!!!**
-**Added support for Linux (32, 64, arm)**
-
-* ### Supports (so far): ###  
+* ### Supports: ###  
   <br>
   
   * **stbi_load** (Default image loader)
+  * **stbi_load_from_memory**
   * **stbi_load_16**
   * **stbi_loadf** (For `.hdr` images)
   * **stbi_info**
   * **stbi_image_free**
-  * **stbi_failure_reason**
   * **stbi_set_flip_vertically_on_load**
-  * **stbi_set_flip_vertically_on_load_thread**
-  * **stbi_set_unpremultiply_on_load**
-  * **stbi_convert_iphone_png_to_rgb**
-  * **stbi_hdr_to_ldr_gamma**
-  * **stbi_hdr_to_ldr_scale**
-  * **stbi_is_16_bit**
-  * **stbi_is_hdr**
-  * **stbi_zlib_decode_buffer**
-  * **stbi_zlib_decode_malloc**
-  * **stbi_zlib_decode_malloc_guesssize**
-  * **stbi_zlib_decode_malloc_guesssize_headerflag**
-  * **stbi_zlib_decode_noheader_buffer**
-  * **stbi_zlib_decode_noheader_malloc**
+  * and more...
 
 
 <br>
@@ -65,7 +48,7 @@ If you want to compile the shared libary yourself, Use the instruction below (ot
 
 # Precompiled shared libs (.dll, .so)
 
-You can find it under [dlls](dlls) folder, but they are also included in the gem
+You can find it under [dlls](lib/dlls) folder, but they are also included in the gem
 
 <br>
 
@@ -97,13 +80,92 @@ nr_channels = ' ' * 4
 
 data = STBIMAGE.stbi_load("blue-poly.jpg", width, height, nr_channels, 0)
 
-puts data # You can use this data in OpenGL for instance.
+data # the retrieved image data
+
+width = width.unpack1('L')
+height height.unpack1('L')
+nr_channels = nr_channels.unpack1('L')
 
-puts width.unpack('l')[0]
-puts height.unpack('l')[0]
-puts nr_channels.unpack('l')[0]
+
+
+# The retrieved data can be used in OpenGL for instance.
+# glTexImage2D(GL_TEXTURE_2D, 0, GL_RGB, width, height, 0, GL_RGB, GL_UNSIGNED_BYTE, data)
+
+stbi_image_free(data)
 ```
 
+<br>
+
+# Function list and examples:
+
+```ruby
+include STBIMAGE
+
+# 1. stbi_load(path_to_file, width_ptr, height_ptr, num_channels_ptr, desired_channels)
+
+width = ' ' * 4         # width_ptr
+height = ' ' * 4        # height_ptr
+nr_channels = ' ' * 4   # num_channels_ptr
+
+data = stbi_load("blue-poly.jpg", width, height, nr_channels, 0)
+
+# retrieve the values from the pointers
+width = width.unpack1('L')             
+height = height.unpack1('L')
+nr_channels = nr_channels.unpack1('L')
+```
+
+```ruby
+include STBIMAGE
+
+# 2. stbi_load_from_memory(ptr_to_image_data_array, image_array_size_in_bytes, width_ptr, height_ptr, num_channels_ptr, desired_channels)
+
+white_texture_raw = [
+  0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A, 0x00, 0x00, 0x00, 0x0D, 0x49, 0x48, 0x44, 0x52, 
+0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x20, 0x08, 0x06, 0x00, 0x00, 0x00, 0x73, 0x7A, 0x7A, 
+0xF4, 0x00, 0x00, 0x00, 0x01, 0x73, 0x52, 0x47, 0x42, 0x00, 0xAE, 0xCE, 0x1C, 0xE9, 0x00, 0x00, 
+0x00, 0x2F, 0x49, 0x44, 0x41, 0x54, 0x58, 0x47, 0xED, 0xD0, 0x41, 0x11, 0x00, 0x00, 0x0C, 0xC2, 
+0xB0, 0xE1, 0x5F, 0x34, 0x93, 0xC1, 0x27, 0x55, 0xD0, 0x4B, 0xDA, 0xF6, 0x86, 0xC5, 0x00, 0x01, 
+0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x00, 0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0xB0, 0x16, 
+0x78, 0x31, 0x4C, 0x7F, 0xA1, 0xF9, 0xB6, 0x23, 0xF9, 0x00, 0x00, 0x00, 0x00, 0x49, 0x45, 0x4E, 
+0x44, 0xAE, 0x42, 0x60, 0x82
+]
+
+texture_size = white_texture_raw.size
+texture_ptr = Fiddle::Pointer.to_ptr(white_texture_raw.pack('C*'))
+
+width = ' ' * 4         # width_ptr
+height = ' ' * 4        # height_ptr
+nr_channels = ' ' * 4   # num_channels_ptr
+
+data = stbi_load_from_file(texture_ptr, texture_size, width, height, nr_channels, 0)
+
+# retrieve the values from the pointers
+width = width.unpack1('L')             
+height = height.unpack1('L')
+nr_channels = nr_channels.unpack1('L')
+```
+
+```ruby
+include STBIMAGE
+
+# 3. stbi_set_flip_vertically_on_load(value)
+# before getting reading the image:
+
+stbi_set_flip_vertically_on_load(1) # flips the image vertically on load
+stbi_set_flip_vertically_on_load(0) # disable flipping
+```
+
+```ruby
+include STBIMAGE
+
+# 4. stbi_image_free(img_data)
+# freeing up the image in memory after we loaded the image. It's essential in order to avoid big memory usage.  
+
+stbi_image_free(data)
+```
+
+
 <br>
 
 # Credit

data/lib/stbimage.rb

@@ -113,7 +113,7 @@ module STBIMAGE
     # 'stbi_load_from_callbacks' 
     # 'stbi_load_from_file'  
     # 'stbi_load_from_file_16'
-    # 'stbi_load_from_memory' 
+    'stbi_uc const* stbi_load_from_memory(stbi_uc const*, int, int*, int*, int*, int)',
     # 'stbi_load_gif_from_memory'
     'float* stbi_loadf(char const*, int*, int*, int*, int)',
     # 'stbi_loadf_from_callbacks'

metadata

@@ -1,19 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: stbimage
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Samuel Keresztes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-10-31 00:00:00.000000000 Z
 dependencies: []
-description: "!Beta Version! A practical image importer/loader. It wraps stb_image.h
-  (ver:2.26 -2020.07.13-). Supported image formats are: JPEG, PNG, TGA, BMP, PSD,
-  GIF(not animation), HDR, PIC, PNM. Checkout the Homepage for usage in Windows, MacOs,
-  Linux or ARM"
+description: 'A practical image importer/loader. It wraps stb_image.h (ver:2.26 -2020.07.13-).
+  Supported image formats are: JPEG, PNG, TGA, BMP, PSD, GIF(not animation), HDR,
+  PIC, PNM. Checkout the Homepage for usage in Windows, MacOs, Linux or ARM'
 email: ''
 executables: []
 extensions: []
@@ -48,8 +47,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Bindings for the often used header stb_image.h
+summary: Bindings of the often used header stb_image.h
 test_files: []