stbimage 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbcc8434378681a4cb30e911d9d1af4e4f121c300e1a291db7b33eeb5505a4f3
-  data.tar.gz: b96b64b299432b39f088a2dbbfd064e77858b1fb57b7b220f89cc5f2f503e39f
+  metadata.gz: 69de01a0ee15b7dc3ce3827d250b061b62d56a3348d49b4cf01f53773439c9ab
+  data.tar.gz: bd2e49f16a3aad172a99645012af9cab9e8cde0a6cb0eef7bb8250ddd888183d
 SHA512:
-  metadata.gz: 01faa35b8bd2b50520ff54924f1d22442a0ec3f3de319597ef4e9a8cda3b549a8160bad6b04af87ea2e16c90394fdfd51e8589b0ab2a12eec84867715cd900dd
-  data.tar.gz: 0ea9d9f48aff7874d1986ef2075b0ce6084f29d27e7fc2bc391e2e8ae706a0e9f8b58d3d99c10b820e44347a821e6a4b625d76a122ba62942fc8325b11833064
+  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>
@@ -42,13 +25,30 @@ Ruby binding of stb-image.h
 * Linux/macOs:\
 `gem install stbimage`
 
-*Note: In macOs you have to compile the dynamic libary (.so) yourself. Although I planned to include it in the future*
+*Note: In Windows and in Linux the gem should work immadiately 'cause we using precompiled libs (see [Usage](#Usage)). In macOs you have to compile the dynamic libary (.so) yourself (see [Compilation](#Compilation)).*
+
+<br>
+
+# Compilation
+
+If you want to compile the shared libary yourself, Use the instruction below (otherwise if the gem works for you than this step is unnecessary):
+
+1. Download sources: [stb-source](stb-source) (stb_image.h, stb_image.c)
+
+2. Navigate to the files in terminal with `cd` 
+
+3. Run the command in terminal (works with macOs, linux, and linux arm):
+`gcc -shared -o libstb.so -fPIC stb_image.c`
+
+4. If nothing shows up than finally you got your own `libstb.so` file what is fully compatible with your system.
+
+5. See [Usage](#Usage) to properly load it to your program.
 
 <br>
 
-# .dll libs
+# Precompiled shared libs (.dll, .so)
 
-You can find it under [dlls](dlls) folder
+You can find it under [dlls](lib/dlls) folder, but they are also included in the gem
 
 <br>
 
@@ -57,11 +57,21 @@ You can find it under [dlls](dlls) folder
 ```ruby
 require 'stbimage'
 
-# use this to load the dll (from gem version 0.2.3 and above)! Only For windows and linux yet
+# When you using the precompiled shared libs. Only works with linux, arm, Windows (in macOs it doesn't work)
 STBIMAGE.load_lib() 
 
-# In macOs you have to provide a dynamic libary (.so) by yourself
-# STBIMAGE.load_lib('your_name.so', 'absolute_path_to_file') 
+# Although when the above function doesn't work for you for some reason (or you are using macOs), please specify arguments in .load_lib function
+
+# 1. When your own .dll, or .so libary is at the same folder as your program. Or you wanna specify relative_path to file
+
+# STBIMAGE.load_lib('your_name.so') 
+# or
+# STBIMAGE.load_lib('your_folder/your_name.so')
+
+# 2. When your own .dll or .so file is somewhere in your storage, please specify absolute path 
+
+# Example:
+# STBIMAGE.load_lib('your_name.so', '/home/user/documents/ruby_proj/dll')
 
 
 width = ' ' * 4
@@ -70,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')
+
+
+
+# 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:
 
-puts width.unpack('l')[0]
-puts height.unpack('l')[0]
-puts nr_channels.unpack('l')[0]
+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

@@ -35,15 +35,15 @@ module STBIMAGE
   def self.load_lib(lib = nil, path = nil, output_error = false)
     if lib == nil && path == nil
 
-      if RUBY_PLATFORM =~ /x86/
+      if RUBY_PLATFORM =~ /64/
 
-        # puts "You have a 32-bit Architecture ruby"
+        # puts "You have a 64-bit Architecture ruby"
         if RUBY_PLATFORM =~ /mswin/ || RUBY_PLATFORM =~ /mingw/
           # puts "With Windows"
-          lib, path = 'stbDLL_x86.dll', "#{__dir__}/../dlls"
+          lib, path = 'stbDLL_x64.dll', "#{__dir__}/dlls"
         elsif RUBY_PLATFORM =~ /linux/ || RUBY_PLATFORM =~ /cygwin/
           # puts "With Linux"
-          lib, path = 'libstb_x86.so', "#{__dir__}/../dlls"
+          lib, path = 'libstb_x64.so', "#{__dir__}/dlls"
         elsif RUBY_PLATFORM =~ /darwin/
           # puts "With macOS"
         else
@@ -53,7 +53,7 @@ module STBIMAGE
       elsif RUBY_PLATFORM =~ /arm/
       
         # puts "You have a arm architecture"
-        lib, path = 'libstb_arm.so', "#{__dir__}/../dlls"
+        lib, path = 'libstb_arm.so', "#{__dir__}/dlls"
       
       elsif RUBY_PLATFORM =~ /java/
       
@@ -61,13 +61,13 @@ module STBIMAGE
       
       else 
       
-        # puts "You have a 64-bit Architecture ruby"
+        # puts "You have a 32-bit Architecture ruby"
         if RUBY_PLATFORM =~ /mswin/ || RUBY_PLATFORM =~ /mingw/
           # puts "With Windows"
-          lib, path = 'stbDLL_x64.dll', "#{__dir__}/../dlls"
+          lib, path = 'stbDLL_x86.dll', "#{__dir__}/dlls"
         elsif RUBY_PLATFORM =~ /linux/ || RUBY_PLATFORM =~ /cygwin/
           # puts "With Linux"
-          lib, path = 'libstb_x64.so', "#{__dir__}/../dlls"
+          lib, path = 'libstb_x86.so', "#{__dir__}/dlls"
         elsif RUBY_PLATFORM =~ /darwin/
           # puts "With macOS"
         else
@@ -81,7 +81,7 @@ module STBIMAGE
     if path
       dlload (path + '/' + lib)
     else
-      dlload (lib)
+      dlload ("#{__dir__}/#{lib}")
     end
     import_symbols(output_error) unless @@stbi_image_import_done
   end
@@ -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'