VirtualBox

Changeset 74989 in vbox


Ignore:
Timestamp:
Oct 23, 2018 9:03:27 AM (6 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
126013
Message:

VideoRec/Main: Documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Main/src-client/VideoRec.cpp

    r74987 r74989  
    389389        mBuf = aBuf;
    390390    }
     391
    391392    /**
    392393     * Convert the next pixel to RGB.
     394     *
    393395     * @returns true on success, false if we have reached the end of the buffer
    394      * @param   aRed    where to store the red value
    395      * @param   aGreen  where to store the green value
    396      * @param   aBlue   where to store the blue value
     396     * @param   aRed            where to store the red value.
     397     * @param   aGreen          where to store the green value.
     398     * @param   aBlue           where to store the blue value.
    397399     */
    398400    bool getRGB(unsigned *aRed, unsigned *aGreen, unsigned *aBlue)
    … …  
    411413
    412414    /**
    413      * Skip forward by a certain number of pixels
    414      * @param aPixels  how many pixels to skip
     415     * Skip forward by a certain number of pixels.
     416     *
     417     * @param aPixels           How many pixels to skip.
    415418     */
    416419    void skip(unsigned aPixels)
    … …  
    419422    }
    420423private:
    421     /** Size of the picture buffer */
     424    /** Size of the picture buffer. */
    422425    unsigned mSize;
    423     /** Current position in the picture buffer */
     426    /** Current position in the picture buffer. */
    424427    unsigned mPos;
    425     /** Address of the picture buffer */
     428    /** Address of the picture buffer. */
    426429    uint8_t *mBuf;
    427430};
    … …  
    442445        mBuf = aBuf;
    443446    }
     447
    444448    /**
    445449     * Convert the next pixel to RGB.
    446      * @returns true on success, false if we have reached the end of the buffer
    447      * @param   aRed    where to store the red value
    448      * @param   aGreen  where to store the green value
    449      * @param   aBlue   where to store the blue value
     450     *
     451     * @returns true on success, false if we have reached the end of the buffer.
     452     * @param   aRed            where to store the red value.
     453     * @param   aGreen          where to store the green value.
     454     * @param   aBlue           where to store the blue value.
    450455     */
    451456    bool getRGB(unsigned *aRed, unsigned *aGreen, unsigned *aBlue)
    … …  
    464469
    465470    /**
    466      * Skip forward by a certain number of pixels
    467      * @param aPixels  how many pixels to skip
     471     * Skip forward by a certain number of pixels.
     472     *
     473     * @param aPixels           How many pixels to skip.
    468474     */
    469475    void skip(unsigned aPixels)
    … …  
    472478    }
    473479private:
    474     /** Size of the picture buffer */
     480    /** Size of the picture buffer. */
    475481    unsigned mSize;
    476     /** Current position in the picture buffer */
     482    /** Current position in the picture buffer. */
    477483    unsigned mPos;
    478     /** Address of the picture buffer */
     484    /** Address of the picture buffer. */
    479485    uint8_t *mBuf;
    480486};
    … …  
    495501        mBuf = aBuf;
    496502    }
     503
    497504    /**
    498505     * Convert the next pixel to RGB.
    499      * @returns true on success, false if we have reached the end of the buffer
    500      * @param   aRed    where to store the red value
    501      * @param   aGreen  where to store the green value
    502      * @param   aBlue   where to store the blue value
     506     *
     507     * @returns true on success, false if we have reached the end of the buffer.
     508     * @param   aRed            Where to store the red value.
     509     * @param   aGreen          where to store the green value.
     510     * @param   aBlue           where to store the blue value.
    503511     */
    504512    bool getRGB(unsigned *aRed, unsigned *aGreen, unsigned *aBlue)
    … …  
    519527
    520528    /**
    521      * Skip forward by a certain number of pixels
    522      * @param aPixels  how many pixels to skip
     529     * Skip forward by a certain number of pixels.
     530     *
     531     * @param aPixels           How many pixels to skip.
    523532     */
    524533    void skip(unsigned aPixels)
    … …  
    527536    }
    528537private:
    529     /** Size of the picture buffer */
     538    /** Size of the picture buffer. */
    530539    unsigned mSize;
    531     /** Current position in the picture buffer */
     540    /** Current position in the picture buffer. */
    532541    unsigned mPos;
    533     /** Address of the picture buffer */
     542    /** Address of the picture buffer. */
    534543    uint8_t *mBuf;
    535544};
    … …  
    17451754 *
    17461755 * @returns IPRT status code.
    1747  * TODO
     1756 * @param   uPixelFormat        Pixel format to use for conversion.
     1757 * @param   paDst               Pointer to destination buffer.
     1758 * @param   uDstWidth           Width (X, in pixels) of destination buffer.
     1759 * @param   uDstHeight          Height (Y, in pixels) of destination buffer.
     1760 * @param   paSrc               Pointer to source buffer.
     1761 * @param   uSrcWidth           Width (X, in pixels) of source buffer.
     1762 * @param   uSrcHeight          Height (Y, in pixels) of source buffer.
    17481763 */
    17491764static int videoRecRGBToYUV(uint32_t uPixelFormat,
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette