Commit 39a27ec2 authored by Vlad Zahorodnii's avatar Vlad Zahorodnii Committed by Vlad Zahorodnii
Browse files

Document the buffer transform property

The buffer transform is a pretty confusing thing, so document it in
order to avoid misleading people.
parent 47f80b99
......@@ -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.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment