tiny_obj 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cb4b288a4c32292401439d4431e618b20db9feb501536521dfc73df992c9297
-  data.tar.gz: 83dc33eeb7db6cd9c80da7cbfe2bac6fcd89a714e802f50e827046a1ec74830b
+  metadata.gz: 1cb16c82d54588fd6f63383314bd351e4f908d093f0330f72d81f6aa76e826cb
+  data.tar.gz: baed73918e0f7f90fb05192940a28457d4e14e282f5616eaecf28f37f8b7b2d6
 SHA512:
-  metadata.gz: 9433112c3fa3db15ac7d8aa80cfda608d6959f979dc6b957e9e44a7c0c4045794ad1e94eb55b9371070907691df3c42678693d95993243b9d97ade144baf9bd2
-  data.tar.gz: fb56c01fbfb2ffa382b2b2ddba6d36a87e65e468787bc253ddfda15a69be6f8aa787bb14c01416dbcb5f6f342a20494a85c8811c36b1373b7ac3270e82cae498
+  metadata.gz: 5b3548ab188a5ecec6b902cd14c5a59c6fd19a17ae35e17050e09fcf378a321e8b7721912f666418b224666251297ff890ccd09b869d29973079931668f98af4
+  data.tar.gz: 132f5624215350be97b4f4b13e87f7f7577820fce2198b26541a1e1d5e91aca0557ecf574f10b4f979506c71aa9b998ed9d5148ca47cc75d43cc3abc62318f37

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tiny_obj (0.2.0)
+    tiny_obj (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -24,10 +24,46 @@ Or install it yourself as:
     require 'tiny_obj'
     obj = TinyOBJ.load("path/to/file.obj") # finds materials in /path/to
     obj = TinyOBJ.load("path/to/file.obj", "path/to/materials/dir")
-    #=> obj is a hash containing :materials, :vertices, :shapes, and other
+
+    hash = obj.to_hash
+    #=> hash is a hash containing :materials, :vertices, :shapes, and other
     #   goodness.
 ```
 
+Converting the OBJ into a hash is convenient but not performant. If you are
+dealing with a large object, you may wish to fill a buffer with data without
+having to convert it into Ruby hashes, arrays and numbers. You can do that
+with TinyOBJ#fill_buffers. Below is a complete example, which uses Fiddle to
+allocate the buffer.
+
+**Note** that using Fiddle is not required (but is convenient since it ships
+with Ruby). Only knowing the memory address of the buffer is necessary. Be
+aware that using the wrong address or not a real (or adequately-sized) buffer
+can lead to undefined behavior and program crashes.
+
+```ruby
+vertex_stride = Fiddle::SIZEOF_FLOAT * (
+                  3 + # 3 floats for each position (x, y, z)
+                  3 + # 3 floats for each normal (x, y, z)
+                  2   # 2 floats for each texture coord (u, v)
+                )
+
+index_stride  = 2 # each index will be one uint16, or two 8-bit bytes
+vertex_buffer = Fiddle::Pointer.malloc(@obj.num_distinct_vertices * vertex_stride)
+index_buffer  = Fiddle::Pointer.malloc(@obj.num_indices           * index_stride)
+
+@obj.fill_buffers(positions:     vertex_buffer,
+                  normals:       vertex_buffer + Fiddle::SIZEOF_FLOAT * 3,
+                  texcoords:     vertex_buffer + Fiddle::SIZEOF_FLOAT * 6,
+                  indices:       index_buffer,
+                  vertex_stride: vertex_stride,
+                  index_stride:  index_stride,
+                  index_type:    :uint16)
+
+# vertex_buffer now contains interleaved vertex data, and
+# index_buffer now contains index data.
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/tiny_obj/version.rb

@@ -1,3 +1,3 @@
 module TinyOBJ
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_obj
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Colin MacKenzie IV
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-17 00:00:00.000000000 Z
+date: 2018-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler