Open 3D Engine GradientSignal Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
GradientSignal::ModifiedImageRegion Struct Reference

#include <ImageGradientModification.h>

Public Member Functions

 ModifiedImageRegion (const ImageGradientSizeData &imageData)
 
void AddPoint (const PixelIndex &pixelIndex)
 Add a pixel's pixel index into the dirty region.
 
AZ::Aabb GetDirtyRegion ()
 
bool IsModified () const
 Returns true if there is a dirty region, false if there isn't.
 

Detailed Description

Handles all of the calculations for figuring out the dirty region AABB for the image gradient based on all its settings. Depending on the tiling and gradient transform settings, painting one pixel on an image can result in dirty regions that are much larger than the one pixel, potentially even infinite in size if the image settings are "mirror" or "repeat".

Member Function Documentation

◆ GetDirtyRegion()

AZ::Aabb GradientSignal::ModifiedImageRegion::GetDirtyRegion ( )

Calculate the dirty region that reflects everywhere that's changed. The output dirty region accounts for image repeats (via tiling / frequency zoom / scale), transform wrapping modes, rotation, and bilinear filtering.


The documentation for this struct was generated from the following file: