Jump to content

Updated documentation site


photo

Recommended Posts

  • 2 weeks later...
Posted

great idea to update, it's so much better!

Posted

Thanks for the update, I agree it's much better.

Posted

It still couldn't be searched for most of the functions and members inside any class...

 

Any fix on this?

Posted

Hi,

 

We have been fixed some issue with finding functions and members inside Classes. Please, inform us, if you still can't find specific information inside the any Class.

 

Sorry for the inconvenience caused.

How to submit a good bug report
---
FTP server for test scenes and user uploads:

Posted

 

403 Forbidden Access was denied to this resource.

 

Resource denied

 

I can no longer access the docs :blink:

 

Edit: I think my licence is due for renewal, but still the SDK doesn't come with an offline version of the docs anymore so this is a pain!

Posted

I realy like the new version, much easier to find specific data like "Widget" etc.

Good job so far :)

Posted

Improved search for documentation.

 

 

The following special operators and modifiers can be used:

  • operator OR: hello | world
  • operator NOT: hello -world, hello !world
  • field search operator: @title hello @content world
  • phrase search operator: "hello world"
  • strict order operator (aka operator "before"): aaa << bbb << ccc
  • exact form modifier: raining =cats and =dogs
Posted

any eta on finishing the material_chain_base page? it has been off for quite a while

Posted

any eta on finishing the material_chain_base page? it has been off for quite a while

Chain material is a tricky one. It requires special mesh for correct result.

You can dig into data/samples/materials/chain_00-chain_02 samples.

This samples construct the skinned mesh files from static mesh source.

The resulted skinned mesh file must contain just two animation frames:

  • The first frame is bind pose frame with all identity transformations.
  • The second frame is frame with real link transformations (of course you can use multiple frames or even update link transformations manually).

To move chain you should just update "bone_offset" material parameter (0.0-1.0 range for one chain step) without affecting bone transformations.

The shader performs linear interpolation between neighbor bones (links) so they should be placed in successive order in skinned mesh file.

Posted

Are there any restrictions with the searching field? For example I was looking for the Perlin function (engine.game.getNoise()) and type "perlin" or "noise" in it. It seems that the searching engine aren't looking into the code-segments and his documentation.

 

EDIT: Sorry, but I searched for that words in the filter-tab, and overlooked the search-bar on top. :)

Posted

By the way, if you are experiencing problems with syntax highlight in the documentation, please clear the page cache (press shift+reload).

Posted

Are there any restrictions with the searching field? For example I was looking for the Perlin function (engine.game.getNoise()) and type "perlin" or "noise" in it. It seems that the searching engine aren't looking into the code-segments and his documentation.

 

EDIT: Sorry, but I searched for that words in the filter-tab, and overlooked the search-bar on top. :)

 

Sorry for the confusion, it's renamed to "navigation filter" now.

Posted

any eta on finishing the material_chain_base page? it has been off for quite a while

 

We plan to complete updating documentation on the materials library in October, most of the work is already done.

  • 1 month later...
Posted

We have also added brief documentation on internals of the engine (available for full source licensees only): https://developer.unigine.com/cpp-docs/

 

It is auto-generated from the code, but contains some useful info like class member lists and inheritance graphs.

Posted

well, this new internals, it's just C++ part, but I believe we really need some documentation about the shader system.

 

But also thanks for that internal documents :)

Posted

We are working on some documentation regarding materials and shader system right now, I hope to see it ready before the next SDK update within 1-2 weeks.

  • Like 1
  • 3 weeks later...
Posted

Some articles are really long, so there is a new neat feature: "jump to top" bar on the right of the page (appears if you have scrolled down).

  • 2 months later...
Posted

In order to avoid confusion, search and quick filter fields are now located next to each other: https://developer.unigine.com/en/docs/1.0/index/

 

Advanced search options (as well as syntax help) are available on the click on the magnifier icon.

 

Quick filter performs filtering navigation pages based on their title.

  • Like 1
Posted

Damn thx!

 

I appreciate the fact that now you can search for everything in your web document now,

 

I don't get why can't you put the Advanced search and Quick filter in the same box though...

×
×
  • Create New...