Nilkins Engine : Documentation/Headers/NilkinsImages/Data/AlignmentDescriptor.h Source File

API Documentation

 // AlignmentDescriptor.h
 //
  
 namespace nkImages
 {
     struct AlignmentDescriptor final
     {
         unsigned int _rowByteAlignment = 1 ;       
         unsigned int _pixelByteAlignment = 1 ;     
  
         ALPHA_MODE _alphaMode = ALPHA_MODE::AUTO ; 
  
         bool _forceRgbFormat = true ;              
         bool _forceRgbReordering = false ;         
     } ;
 }

nkImages::AlignmentDescriptor::_pixelByteAlignment

unsigned int _pixelByteAlignment

Alignment of a pixel inside a texture. A pixel is a set of channels depending on the format,...

Definition: AlignmentDescriptor.h:14

nkImages::ALPHA_MODE

ALPHA_MODE

Lists possible modes for the alpha channel.

Definition: AlphaMode.h:15

nkImages::AlignmentDescriptor::_forceRgbReordering

bool _forceRgbReordering

Whether images that are found to be ordered in BGR fashion should be reordered into an RGB format.

Definition: AlignmentDescriptor.h:19

nkImages::AlignmentDescriptor::_alphaMode

ALPHA_MODE _alphaMode

Describes the alpha mode the output should satisfy.

Definition: AlignmentDescriptor.h:16

nkImages::ALPHA_MODE::AUTO

@ AUTO

Automatic, the alpha channel will be available as described by the data parsed.

nkImages::AlignmentDescriptor

Holds information about alignment constraints.

Definition: AlignmentDescriptor.h:12

Encompasses all API of component NilkinsImages.

Definition: BmpEncoder.h:7

nkImages::AlignmentDescriptor::_forceRgbFormat

bool _forceRgbFormat

Whether images that are not RGB type formats should be output as RGB (converted on the fly).

Definition: AlignmentDescriptor.h:18

nkImages::AlignmentDescriptor::_rowByteAlignment

unsigned int _rowByteAlignment

Alignment of a row inside a texture. A row is a set of pixels forming a line in the texture.

Definition: AlignmentDescriptor.h:13