SurfaceT /

A null Surface.

Allocates a Surface of size width X height , with an optional alpha channel. The default value for channelOrder selects a platform default.

Allocates a Surface of size width X height , with an optional alpha channel. constraints allows specification of channel order and rowBytes constraints as a function of width.

Constructs a surface from the memory pointed to by data . Does not assume ownership of the memory in data , which consequently should not be freed while the Surface is still in use.

Constructs a Surface from an imageSource and optional constraints . Includes alpha channel if one is present in the ImageSource .

Constructs a Surface from an imageSource and optional constraints . Includes alpha channel based on alpha .

Creates a clone of rhs . Matches rowBytes and channel order of rhs , but creates its own dataStore.

Surface move constructor.

Returns the width of the Surface in pixels.

Returns the height of the Surface in pixels.

Returns the size of the Surface in pixels.

Returns the Surface aspect ratio, which is its width / height.

Returns the bounding Area of the Surface in pixels: [0,0]-(width,height)

Returns whether the Surface contains an alpha channel.

Returns whether the Surface color data is premultiplied by its alpha channel or not.

Sets whether the Surface color data should be interpreted as being premultiplied by its alpha channel or not.

Returns the width of a row of the Surface measured in bytes, which is not necessarily getWidth() * getPixelInc()

Returns the amount to increment a T* to increment by a pixel. Analogous to the number of channels, which is either 3 or 4.

Returns the number of bytes to increment by a pixel. Analogous to the number of channels, (which is either 3 or 4) * sizeof(T)

Returns a new Surface which is a duplicate. If copyPixels the pixel values are copied, otherwise the clone's pixels remain uninitialized.

Returns a new Surface which is a duplicate of an Area area . If copyPixels the pixel values are copied, otherwise the clone's pixels remain uninitialized.

Retuns the raw data of an image as a pointer to either uin8t_t values in the case of a Surface8u or floats in the case of a Surface32f.

Returns a pointer to the red channel data of the pixel located at offset . Result is a uint8_t* for Surface8u and a float* for Surface32f.

Returns a pointer to the green channel data of the pixel located at offset . Result is a uint8_t* for Surface8u and a float* for Surface32f.

Returns a pointer to the blue channel data of the pixel located at offset . Result is a uint8_t* for Surface8u and a float* for Surface32f.

Returns a pointer to the alpha channel data of the pixel located at offset . Result is a uint8_t* for Surface8u and a float* for Surface32f. Undefined for Surfaces without an alpha channel.

Returns the shared_ptr to the underlying pixel data. Maybe be nullptr if the Surface does not own its data.

Returns the channel order of the Surface, the in-memory ordering of the channels of each pixel.

Returns the in-memory offset relative to a pixel for the red data. For example, for RGBA, returns 0.

Returns the in-memory offset relative to a pixel for the red data. For example, for RGBA, returns 1.

Returns the in-memory offset relative to a pixel for the red data. For example, for RGBA, returns 2.

Returns the in-memory offset relative to a pixel for the red data. For example, for RGBA, returns 3. Returns SurfaceChannelOrder::INVALID in the absence of an alpha channel.

Sets the channel order of the Surface, the in-memory ordering of the channels of each pixel. Call does not modify any pixel data, but does modify its interpretation.

Returns a reference to a Channel channelIndex indexed according to how the channels are arranged per the SurfaceChannelOrder .

Returns a const reference to a Channel channelIndex indexed according to how the channels are arranged per the SurfaceChannelOrder .

Returns a reference to the red Channel of the Surface

Returns a reference to the green Channel of the Surface

Returns a reference to the blue Channel of the Surface

Returns a reference to the alpha Channel of the Surface. Undefined in the absence of an alpha channel.

Returns a const reference to the red Channel of the Surface

Returns a const reference to the green Channel of the Surface

Returns a const reference to the blue Channel of the Surface

Returns a const reference to the alpha Channel of the Surface. Undefined in the absence of an alpha channel.

Convenience method for getting a single pixel. For performance-sensitive code consider Surface::Iter instead.

Convenience method for setting a single pixel. For performance-sensitive code consider Surface::Iter instead.

Convenience method for setting a single pixel. For performance-sensitive code consider Surface::Iter instead.

Copies the Area srcArea of the Surface srcSurface to this Surface. The destination Area is srcArea offset by relativeOffset .

Returns an averaged color for the Area defined by area .

Returns an Iter which iterates the entire Surface.

Returns an Iter which iterates the Area area .

Returns a ConstIter which iterates the entire Surface.

Returns a ConstIter which iterates the Area area .

Creates a SurfaceRef of size width X height , with an optional alpha channel. The default value for channelOrder selects a platform default.

Creates a SurfaceRef of size width X height , with an optional alpha channel. constraints allows specification of channel order and rowBytes constraints as a function of width.

Creates a SurfaceRef from the memory pointed to by data . Does not assume ownership of the memory in data , which consequently should not be freed while the Surface is still in use.

Creates a SurfaceRef from an imageSource and optional constraints . Includes alpha channel if one is present in the ImageSource .

Creates a SurfaceRef from an imageSource and optional constraints . Includes alpha channel based on alpha .

Creates s SurfaceRef which is a clone of the Surface surface , and with its own dataStore.