Material documentation

[emackey]

Some fields are undocumented.

Material.prototype.isTranslucent
Material.DefaultImageId
Material.DefaultCubeMapId

Material.ColorType
Material.ImageType
Material.DiffuseMapType
Material.AlphaMapType
Material.SpecularMapType
Material.EmissionMapType
Material.BumpMapType
Material.NormalMapType
Material.GridType
Material.StripeType
Material.CheckerboardType
Material.DotType
Material.WaterType
Material.RimLightingType
Material.FadeType
Material.PolylineArrowType
Material.PolylineGlowType
Material.PolylineOutlineType

[mramato]

Also, these types are treated as constants but do not follow the uppercase/underscore convention; i.e. COLOR_TYPE instead of ColorType.

[mramato]

Also, should we create a MaterialType enum to contain all of the types instead of having them on Material itself?

As soon as we get an answer, someone can actually work on this.

[pjcozzi]

The constants are documented-ish at the top of Material. I would be fine with just dropping the *Type constants in place of strings since I always find them confusing anyway (#1185, #640).

[emackey]

I don't have a strong opinion here, but I'll point out that using documented enums would allow a Sandcastle user to double-click the material type and get the direct link to docs on the available uniforms for that particular type (which is how I discovered this bug; I attempted to double-click a type I was curious about).

I don't think the Color class is broken up with a separate enum class for all the named colors, perhaps we can keep Material as a single class as well?

[pjcozzi]

I'd rather not require the user to have to interact with yet another type so that the Sandcastle feature works. Just leave them or drop them.