Document the buffer transform property

The buffer transform is a pretty confusing thing, so document it in
order to avoid misleading people.
This commit is contained in:
Vlad Zahorodnii 2020-06-19 10:07:22 +03:00 committed by Vlad Zahorodnii
parent ecca34dea3
commit 6adaf7bcc6

View file

@ -146,6 +146,13 @@ public:
QRegion input() const;
bool inputIsInfinite() const;
qint32 bufferScale() const;
/**
* Returns the buffer transform that had been applied to the buffer to compensate for
* output rotation.
*
* If the surface is on an output that is rotated 90 degrees clockwise, the buffer will
* be rotated 90 degrees counter clockwise.
*/
OutputInterface::Transform bufferTransform() const;
/**
* @returns the current BufferInterface, might be @c nullptr.