stbimage 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32f96cdeb03fd88a7e4b6d29158af7d6ae1a646001b01914d8159d98b1765528
-  data.tar.gz: 1e02ba30e6eace68f587b89914109aa379fe1361830bde57af79a7fdb4c37892
+  metadata.gz: db813db9f8656c1b4e4ab644d47f97c561bcca2099ef6983ade9bc28a16f5579
+  data.tar.gz: 5668270ce32c8305e358cc35626c810fd58a69094b67be24c2afe67858e133ec
 SHA512:
-  metadata.gz: 5ac1c2781afdd7561d3d890af931a89360db9cc4cdf09ac0754cde72ffb328bd400f44f5b4b39eb5aefdb5dffeb0cb7b421cf0e7e33246f05bcb5eb7ce2a72ea
-  data.tar.gz: c8591f92dfbf67d77a77e6b3980392133a894f6c700d9a9e61c16842cc11571929234afda38e2afe0ee0172bcfcb1d24ec9e4e3d285a93d388d8a17e91c4a2ce
+  metadata.gz: 3ffab71c7a5bb8f28af4c67b0fd3add92a031f74b36a2c5d0aa24d587996ea7bc93d166b812215fcf6ac87965358f483c2c5ac7ecea9ecc13bb239f22302d90a
+  data.tar.gz: 26a238c2444b93a137b720fac42b0cdf6c0780120b0c3870f3d63a179d1e47d99f111c8b72867e2ce484a9f11a55e5d8b0fa699c016784b10ff8a2d149a0709f

data/README.md

@@ -1,31 +1,67 @@
-# stbimage-ruby
-Binding of stb-image into the ruby programing language.
+# STBIMAGE     
 
-# Tutorials
 
-1. To use this gem first install it with:
+
+Ruby binding of stb-image.h
+
+**Works well on windows!!!**
+
+* ### Supports (so far): ###  
+  <br>
+  
+  * **stbi_load** (Default image loader)
+  * **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**
+
+
+<br>
+
+# Installation
+
+* Windows:\
 `gem install stbimage`
-2. Require it in your project with\
-`require 'stbimage'`
-3. Load your dll dynamic libary what is in your projects root folder!!! (Download the dlls: visit my webpage.)\
-`STBIMAGE.load_lib()`
-4. Then you can use it :D
 
-# About the dll libs
+* Linux/macOs:\
+`gem install stbimage`
+
+*Note: In Linux/macOs you have to compile the dynamic libary (.so) yourself. Although I planned to include it in the future*
+
+<br>
+
+# .dll libs
 
 You can find it under [dlls](dlls) folder
 
-# A full Example:
+<br>
+
+# Usage
 
 ```ruby
-require 'stb_image'
+require 'stbimage'
 
-# Note that you need to name your dll file to stbDLL.dll in this case
+# use this to load the dll (from gem version 0.2.3 and above)! Only For windows yet
 STBIMAGE.load_lib() 
-# Or if you want to specify another name for it, use: 
-# STBIMAGE.load_lib('your_name.dll')
 
-# But don't forget that ruby searches your dll file in your current directory!
+# In linux and macOs you have to provide a dynamic libary (.so) 
+# STBIMAGE.load_lib('your_name.so', 'absolute_path_to_file')
+
 
 width = ' ' * 4
 height = ' ' * 4
@@ -33,14 +69,47 @@ nr_channels = ' ' * 4
 
 data = STBIMAGE.stbi_load("blue-poly.jpg", width, height, nr_channels, 0)
 
-puts data
+puts data # You can use this data in OpenGL for instance.
 
 puts width.unpack('l')[0]
 puts height.unpack('l')[0]
 puts nr_channels.unpack('l')[0]
 ```
 
+<br>
+
 # Credit
 
-Credit to Vaiorabbit who made the bindings of opengl into ruby! This wrapper is based on his glfw wrapper. :D \
+* Credit to Vaiorabbit who made the bindings of opengl into ruby! This wrapper is based on his glfw wrapper.
 His repo: https://github.com/vaiorabbit/ruby-opengl
+
+* stb_image.h by Sean Barret. Repo: https://github.com/nothings/stb/blob/master/stb_image.h
+
+
+<br>
+
+# Licence
+
+MIT License
+
+```
+Copyright (c) 2021 Samuel Keresztes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```

data/lib/stbimage.rb

@@ -29,19 +29,18 @@ module STBIMAGE
   end
 
   
-  @@glfw_import_done = false
+  @@stbi_image_import_done = false
 
-=begin
-Load native dll libary 
-- lib = the name of the file
-- path = route to the file
-=end
+  # Load native dll libary 
   def self.load_lib(lib = nil, path = nil, output_error = false)
     if lib == nil && path == nil
       if RUBY_PLATFORM == "x64-mswin64_140" || RUBY_PLATFORM == "x64-mingw32"
         lib, path = 'stbDLL_x64.dll', "#{__dir__}/../dlls"
       elsif RUBY_PLATFORM == "x86-mingw32"
         lib, path = 'stbDLL_x86.dll', "#{__dir__}/../dlls"
+      # elsif RUBY_PLATFORM == ""
+      else
+        
       end
     end
 
@@ -50,31 +49,31 @@ Load native dll libary
     else
       dlload (lib)
     end
-    import_symbols(output_error) unless @@glfw_import_done
+    import_symbols(output_error) unless @@stbi_image_import_done
   end
 
   @@lib_signature = [
     'void stbi_convert_iphone_png_to_rgb(int)',
-    'const char *stbi_failure_reason(void)',
+    'const char* stbi_failure_reason(void)',
     'void stbi_hdr_to_ldr_gamma(float)',
     'void stbi_hdr_to_ldr_scale(float)',
     'void stbi_image_free(void*)',
     'int stbi_info(char const* , int*, int*, int*)', 
-    # 'int stbi_info_from_callbacks(stbi_io_callbacks const*, void*, int*, int*, comp*)'
+    # 'stbi_info_from_callbacks'
     # 'stbi_info_from_file'
     # 'stbi_info_from_memory'
-    # 'stbi_is_16_bit'
+    'int stbi_is_16_bit(char const*)',
     # 'stbi_is_16_bit_from_callbacks'
     # 'stbi_is_16_bit_from_file'
     # 'stbi_is_16_bit_from_memory'
-    # 'stbi_is_hdr'
+    'int stbi_is_hdr(char const*)',
     # 'stbi_is_hdr_from_callbacks'
     # 'stbi_is_hdr_from_file'
     # 'stbi_is_hdr_from_memory'
-    # 'stbi_ldr_to_hdr_gamma'
-    # 'stbi_ldr_to_hdr_scale'
+    'void stbi_ldr_to_hdr_gamma(float)',
+    'void stbi_ldr_to_hdr_scale(float)',
     'stbi_uc* stbi_load(char const*, int*, int*, int*, int)', 
-    # 'stbi_load_16'
+    'stbi_us* stbi_load_16(char const*, int*, int*, int*, int)',
     # 'stbi_load_16_from_callbacks'
     # 'stbi_load_16_from_memory' 
     # 'stbi_load_from_callbacks' 
@@ -82,37 +81,38 @@ Load native dll libary
     # 'stbi_load_from_file_16'
     # 'stbi_load_from_memory' 
     # 'stbi_load_gif_from_memory'
-    # 'stbi_loadf' 
+    'float* stbi_loadf(char const*, int*, int*, int*, int)',
     # 'stbi_loadf_from_callbacks'
     # 'stbi_loadf_from_file' 
     # 'stbi_loadf_from_memory'
-    'void stbi_set_flip_vertically_on_load(int)'
-    # 'stbi_set_flip_vertically_on_load_thread'
-    # 'stbi_set_unpremultiply_on_load' 
-    # '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'
+    'void stbi_set_flip_vertically_on_load(int)',
+    'void stbi_set_flip_vertically_on_load_thread(int)',
+    'void stbi_set_unpremultiply_on_load(int)',
+    'int stbi_zlib_decode_buffer(char*, int, const char*, int)', 
+    'char* stbi_zlib_decode_malloc(const char*, int, int*)', 
+    'char* stbi_zlib_decode_malloc_guesssize(const char*, int, int, int*)',
+    'char* stbi_zlib_decode_malloc_guesssize_headerflag(const char*, int, int, int*, int)',
+    'int stbi_zlib_decode_noheader_buffer(char*, int, const char*, int)', 
+    'char* stbi_zlib_decode_noheader_malloc(const char*, int, int*)'
+
   ]
 
   def self.import_symbols(output_error = false)
     typealias 'stbi_uc', 'unsigned char'
-    typealias 'stbi_us', 'unsigned short' 
-    
+    typealias 'stbi_us', 'unsigned short'
 
     # function
     @@lib_signature.each do |sig|
+
       begin
         extern sig
       rescue
         $stderr.puts("[Warning] Failed to import #{sig}.") if output_error
       end
+
     end
 
-    @@glfw_import_done = true
+        @@stbi_image_import_done = true
+        
   end
-
-end
-
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stbimage
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Keresztes
@@ -10,11 +10,11 @@ bindir: bin
 cert_chain: []
 date: 2021-01-09 00:00:00.000000000 Z
 dependencies: []
-description: "!Beta Version! Will be developed! So far compatible with: stbi_load,
-  stbi_set_flip_vertically_on_load(). \n  Only works with windows so far!!!!! (win32/win64).
-  PLEASE CHECK OUT THE HOMEPAGE FOR MORE INFO AND EXAMPLE. With 0.2.3 and above dlls
-  are included so 'STBIMAGE.load_lib()'\n   should be enough for linking shared liaries.
-  So it's worth to upgrade 0.2.3! "
+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. Only works well with windows so far (win32/win64),
+  but linux/macOs users also can use it. Checkout the Homepage for more info (installation,
+  usage and other information)"
 email: ''
 executables: []
 extensions: []