seanbaxter / shaders

Circle C++ shaders
479 stars 16 forks source link

(doc) Circle C++ shader restriction list #8

Open FROL256 opened 3 years ago

FROL256 commented 3 years ago

It would be nice to have a doc page with list of features which should not be used at all (due to some fundamental restrictions of SPIR-V) or should not be used at least for a while (due to they are not implemented yet). For example, like "OpenCL C Restrictions" section here https://github.com/google/clspv/blob/master/docs/OpenCLCOnVulkan.md

Currently there is a section in documentation called "Approaching Circle shaders from C++" which is ok, but ... user should guess about concrete features (and btw it is not evident that this section is about restrictions). I think that just stupid "do this, don't do that" with some examples which features are strictly prohibited would be enough and helps.

It would also be great to place this in different .md file because main page became large )

seanbaxter commented 3 years ago

Not a bad idea.

Also, I should split the document into an examples page and a reference page before it gets much longer.