Fix readme markup

This commit is contained in:
Leonetienne 2022-06-01 21:32:32 +02:00
parent a4ebcd16b9
commit 1e51c89772
No known key found for this signature in database
GPG Key ID: C33879CD92E9708C

View File

@ -8,13 +8,13 @@ Disclaimer!!:
## Basic Usage ## Basic Usage
*Assuming: *Assuming:
```c++ ```cpp
using namespace Leonetienne::BmpPP; using namespace Leonetienne::BmpPP;
using namespace Leonetienne::Eule; using namespace Leonetienne::Eule;
``` ```
##### Read image ##### Read image
```c++ ```cpp
BMP bmp("cute.bmp"); BMP bmp("cute.bmp");
// or // or
@ -23,12 +23,12 @@ bmp.Read("cute.bmp");
``` ```
##### Write image ##### Write image
```c++ ```cpp
bmp.Write("cute.bmp"); bmp.Write("cute.bmp");
``` ```
##### Create a new image ##### Create a new image
```c++ ```cpp
// RGBA image // RGBA image
BMP bmp(Vector2i(800, 600)); BMP bmp(Vector2i(800, 600));
@ -40,7 +40,7 @@ BMP bmp(Vector2i(800, 600), Colormode::RGB);
``` ```
##### Edit pixel data ##### Edit pixel data
```c++ ```cpp
// Set pixel grayscale value // Set pixel grayscale value
bmp.SetPixel(Vector2i(60, 50), 128); bmp.SetPixel(Vector2i(60, 50), 128);
@ -55,7 +55,7 @@ bmp.GetPixel(Vector2i(60, 50))[1] = 128;
``` ```
##### Get pixel data ##### Get pixel data
```c++ ```cpp
// Assuming image is RGBA // Assuming image is RGBA
std::uint8_t* pixel = bmp.GetPixel(Vector2i(60, 50)); std::uint8_t* pixel = bmp.GetPixel(Vector2i(60, 50));
@ -66,7 +66,7 @@ std::uint8_t a = pixel[3];
``` ```
##### Convert between RGB and RGBA ##### Convert between RGB and RGBA
```c++ ```cpp
// This is RGBA // This is RGBA
BMP bmp(Vector2i(800, 600), Colormode::RGBA); BMP bmp(Vector2i(800, 600), Colormode::RGBA);
@ -77,7 +77,7 @@ bmp.ConvertTo(Colormode::RGB);
``` ```
##### Mirror images ##### Mirror images
```c++ ```cpp
// Mirror horizontally // Mirror horizontally
BMP mirroredImage_hor = image.MirrorHorizontally(); BMP mirroredImage_hor = image.MirrorHorizontally();
@ -86,7 +86,7 @@ BMP mirroredImage_ver = image.MirrorVertically();
``` ```
##### Rotate images ##### Rotate images
```c++ ```cpp
// Rotate by 90 degrees, clockwise // Rotate by 90 degrees, clockwise
BMP rotatedImage = image.Rotate90degClockwise(); BMP rotatedImage = image.Rotate90degClockwise();
@ -98,13 +98,13 @@ BMP rotatedImage = image.Rotate180deg();
``` ```
##### Crop images ##### Crop images
```c++ ```cpp
// Extract the region topleft={25, 60}, size={150, 200} // Extract the region topleft={25, 60}, size={150, 200}
BMP cropped = bmp.Crop(Vector2i(25, 60), Vector2i(150, 200)); BMP cropped = bmp.Crop(Vector2i(25, 60), Vector2i(150, 200));
``` ```
##### Fill channels ##### Fill channels
```c++ ```cpp
// Want to set the entire ALPHA channel to 255? // Want to set the entire ALPHA channel to 255?
bmp.FillChannel(3, 255); bmp.FillChannel(3, 255);
@ -112,7 +112,7 @@ bmp.FillChannel(3, 255);
``` ```
##### Swapping channels ##### Swapping channels
```c++ ```cpp
// Convert BGR to RGB, by swapping the red and blue channels. // Convert BGR to RGB, by swapping the red and blue channels.
bmp.SwapChannels(0, 2); bmp.SwapChannels(0, 2);
@ -120,7 +120,7 @@ bmp.SwapChannels(0, 2);
``` ```
##### Feed in an existing pixel buffer ##### Feed in an existing pixel buffer
```c++ ```cpp
// OK, this is a bit more complex, but here's how to do it // OK, this is a bit more complex, but here's how to do it
// This is assumed to be an RGBA pixel buffer, formatted like: // This is assumed to be an RGBA pixel buffer, formatted like: