add images to The Domain Name-Space page.

master
Craig Oates 5 years ago
parent
commit
959678e107
  1. 8
      The-Domain-Name-Space.md
  2. BIN
      attachments/domain-types-relationship.png
  3. BIN
      attachments/overlay-examples.png

8
The-Domain-Name-Space.md

@ -8,7 +8,7 @@ Together they describe how your placeholder image will look.
To help you become more familiar with them, it might help if you think of them like Matryoshka Dolls (I.E. "Russian Dolls"). The reason why is because of how the types interact with each other. The `ImageSpec` holds an `OverlaySpec` which holds an `OverlayType`. Granted, this is a high level overview but this relationship is an important part of knowing how to use SmoulderingBeachBall (S.B.B.)
IMAGE OF THE RUSSIAN DOLL RELATIONSHIP
![domain-types relationship](attachments/domain-types-relationship.png)
Having said the above, you can circumvent all this by setting the "overlay" property to "None" when creating your `ImageSpec`. For example, take a look at the following piece of code:
@ -26,7 +26,7 @@ It is, also, worth pointing out you do not need to specify the file name (A.K.A.
If you would like to read the actual source code in `DomainTypes`, you can do so by using the following link:
- ["Domain.fs"](https://gitlab.com/craig.oates/Smouldering-Beach-Ball/blob/master/SmoulderingBeachBall/Domain.fs)
- [Domain.fs](https://gitlab.com/craig.oates/Smouldering-Beach-Ball/blob/master/SmoulderingBeachBall/Domain.fs)
## Domain Types Breakdown
@ -38,9 +38,7 @@ The following examples (amongst others) are viewable in "Snippets". You can get
This type describes what type of overlay you want on your placeholder image. `Border` adds a border around the sides of your image and `Full` adds an "X" across the image. The colour of "X" will be the same as the border. Here are some examples:
IMAGE OF BORDER IMAGE
IMAGE OF FULL IMAGE
![overlays examples](attachments/overlay-examples.png)
When it comes to creating an `OverlayType`, you tend to not make a "standalone" version. Instead, you will usually specify the type when you create an `OverlaySpec`. For example:

BIN
attachments/domain-types-relationship.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

BIN
attachments/overlay-examples.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Loading…
Cancel
Save