Rename and document TransImageGetter::getPixelsRW() to make it more obvious
that it bypasses the normal conversion logic.
git-svn-id: svn://svn.code.sf.net/p/tigervnc/code/trunk@4754 3789f03b-4d11-0410-bbf8-ca57d06f2519
diff --git a/common/rfb/TransImageGetter.h b/common/rfb/TransImageGetter.h
index 8fde743..1ad49b7 100644
--- a/common/rfb/TransImageGetter.h
+++ b/common/rfb/TransImageGetter.h
@@ -72,7 +72,11 @@
// padding will be outStride-r.width() pixels).
void getImage(void* outPtr, const Rect& r, int outStride=0);
- rdr::U8 *getPixelsRW(const Rect &r, int *stride);
+ // getRawPixelsRW() gets the given rectangle of data directly from the
+ // underlying PixelBuffer, bypassing the translation logic. Only use
+ // this when doing something that's independent of the client's pixel
+ // format.
+ rdr::U8 *getRawPixelsRW(const Rect &r, int *stride);
// setPixelBuffer() changes the pixel buffer to be used. The new pixel
// buffer MUST have the same pixel format as the old one - if not you