ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11412 Commits
21 Branches
19 Tags
70 MiB
Tree: 683a9fa718
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '683a9fa718'
${ noResults }
magnum/doc/generated/README.md

58 lines
2.1 KiB
Raw Normal View History Unescape

Shaders: there's never enough documentation. Each shader now has sample image, example mesh configuration and example rendering setup. Also properly documented all attribute types and made introductory chapter for whole Shaders namespace.
11 years ago
Source files for images in Magnum documentation
-----------------------------------------------
doc: updated also Getting Started image to the new color.
11 years ago
Compile and install Magnum with `Sdl2Application`, windowless application for
your platform and `magnum-distancefieldconverter` utility and any `PngImporter`
and `PngImageConverter` plugins from Magnum Plugins.
Shaders: there's never enough documentation. Each shader now has sample image, example mesh configuration and example rendering setup. Also properly documented all attribute types and made introductory chapter for whole Shaders namespace.
11 years ago
Create build dir, point CMake to this directory and compile the executables:
mkdir build-doc
cd build-doc
cmake ../doc/generated
cmake --build .
doc: show how each primitive looks.
8 years ago
### Primitive images
Generated by the `primitives` executable. Run it in this directory, the output
is put into `doc/` directory. Apply `pngcrush` to them for smaller file sizes:
for f in $(ls primitives-*.png); do pngcrush -ow $f; done
Shaders: there's never enough documentation. Each shader now has sample image, example mesh configuration and example rendering setup. Also properly documented all attribute types and made introductory chapter for whole Shaders namespace.
11 years ago
### Shader images
Generated by the `shaders` executable. Must be run in this directory, the
output is put into `doc/` directory. The executable requires two textures:
doc: adapt image generation README to inkscape / imagemagick changes. Heh, interesting how drastically random software changes over the years.
1 year ago
- `vector.png`, generated as full-page PNG output at 96 DPI from `vector.svg`,
Shaders: there's never enough documentation. Each shader now has sample image, example mesh configuration and example rendering setup. Also properly documented all attribute types and made introductory chapter for whole Shaders namespace.
11 years ago
converted to pure grayscale using imagemagick:
```bash
doc: adapt image generation README to inkscape / imagemagick changes. Heh, interesting how drastically random software changes over the years.
1 year ago
mogrify -flatten -background '#ffffff' -colorspace gray vector.png
Shaders: there's never enough documentation. Each shader now has sample image, example mesh configuration and example rendering setup. Also properly documented all attribute types and made introductory chapter for whole Shaders namespace.
11 years ago
```
doc: adapt image generation README to inkscape / imagemagick changes. Heh, interesting how drastically random software changes over the years.
1 year ago
- `vector-distancefield.png`, generated as full-page PNG output at 384 DPI
doc: update also the Shaders::DistanceFieldVector image. No longer slightly shifted either.
3 years ago
(1024x1024) to `vector-src.png` and then processed through
`magnum-distancefieldconverter`
Shaders: there's never enough documentation. Each shader now has sample image, example mesh configuration and example rendering setup. Also properly documented all attribute types and made introductory chapter for whole Shaders namespace.
11 years ago
```bash
magnum-distancefieldconverter --importer PngImporter --converter PngImageConverter --output-size "64 64" --radius 16 vector-src.png vector-distancefield.png
```
doc: apply pngcrush to shader images.
8 years ago
Apply `pngcrush` to the result for smaller file sizes:
for f in $(ls shaders-*.png); do pngcrush -ow $f; done
TextureTools: rewrite docs for DistanceFieldGL from scratch. I fixed some minor English crimes in the method docs and then realized this is all just bad and the utter uselessness and lack of information led to way too many confused questions over the years. So let's do it properly, finally, ugh.
1 year ago
### Distance field vector images
Similarly as above, just with slightly different parameters. The
`distancefield-src.png` is generated as full-page PNG output at 192 DPI
(512x512) from `vector.svg`, the `distancefield-dst.png` is then converted with
```bash
magnum-distancefieldconverter distancefield-src.png distancefield-dst.png --output-size "128 128" --radius 24
```
This is chosen so it corresponds to the `TextureTools::DistanceFieldGL` doc
snippet where it takes a 256x256 image and converts it to 64x64 with a radius
12, but is scaled twice to look better on HiDPI displays.