Jump to content

TextureFormat missing in Documentation


Roland
 Share

Recommended Posts

Solution: Add following lines to CPP\Constants.md

#### TextureFormat #### 
- TEXTURE_FORMAT_UNDEFINED
- TEXTURE_RGBA_UINT
- TEXTURE_RED
- TEXTURE_RG
- TEXTURE_RGB
- TEXTURE_RGBA
- TEXTURE_BGR
- TEXTURE_BGRA
- TEXTURE_RGB8
- TEXTURE_RGBA8
- TEXTURE_BGR8
- TEXTURE_BGRA8
- TEXTURE_RED16
- TEXTURE_R16
- TEXTURE_RGBA16
- TEXTURE_BC1
- TEXTURE_DXT1
- TEXTURE_BC3
- TEXTURE_DXT5 = TEXTURE_BC3
- TEXTURE_BC5
- TEXTURE_BC7
- TEXTURE_COLOR
- TEXTURE_DEPTH

 

AV MX Linux

Link to comment
Share on other sites

I am having trouble deciding where to document constants. I've been listing them in the relevant command descriptions. You will notice that constants.md isn't actually listed in the table of contents. If I have a link in a the documentation somewhere else, should it link to a page where all the constants are listed? Should it link to a specific anchor link within a single page? Or should different groups of constants be broken up into different pages? These are questions I have not figured out yet.

  • Like 1

My job is to make tools you love, with the features you want, and performance you can't live without.

Link to comment
Share on other sites

Ok I see. My vote goes for the last suggestion "different groups of constants be broken up into different pages". 
I don't know how you divide them up in the source code, but as I see it the same principle should be used there.
Not having any global constants.h 

AV MX Linux

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

 Share

×
×
  • Create New...