Difference between revisions of "Unit Framebuffer"

Revision as of 00:18, 7 October 2016

@@ Line 689: / Line 689: @@
 <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;">
 <pre style="border: 0; padding-bottom:0px;">function FramebufferDeviceSwap(Value:LongWord):LongWord; inline;</pre>
-<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
+<div style="font-size: 14px; padding-left: 12px;">'''Description:''' No longer required (See ColorDefaultToFormat and ColorFormatToDefault)</div>
 <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 {| class="wikitable" style="font-size: 14px; background: white;"

Framebuffer	The framebuffer device to allocate
Properties	The framebuffer properties (Width/Height/Depth etc) to use for allocation (Optional)
Return	ERROR_SUCCESS if completed or another error code on failure

Framebuffer	The framebuffer device to release
Return	ERROR_SUCCESS if completed or another error code on failure

Framebuffer	The framebuffer device to blank
Blank	Turn off the display if True / Turn on the display if False
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Not all framebuffer devices support blank, returns ERROR_CALL_NOT_IMPLEMENTED if not supported. Devices that support blank should set the flag FRAMEBUFFER_FLAG_BLANK.

Framebuffer	The framebuffer device to read from
X	The column to start reading from
Y	The row to start reading from
Buffer	Pointer to a buffer to receive the read pixels
Len	The number of pixels to read starting at X,Y
Flags	The flags for the transfer (eg FRAMEBUFFER_TRANSFER_DMA)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Pixel data will be returned in the color format of the framebuffer. The default method assumes that framebuffer memory is DMA coherent and does not require cache cleaning before a DMA read.

Framebuffer	The framebuffer device to write to
X	The column to start writing from
Y	The row to start writing from
Buffer	Pointer to a buffer containing the pixels to write
Len	The number of pixels to write starting at X,Y
Flags	The flags for the transfer (eg FRAMEBUFFER_TRANSFER_DMA)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Caller must ensure pixel data is in the correct color format for the framebuffer. The default method assumes that framebuffer memory is DMA coherent and does not require cache invalidation after a DMA write.

Framebuffer	The framebuffer device to mark
X	The starting column of the mark
Y	The starting row of the mark
Width	The number of columns to mark
Height	The number of rows to mark
Flags	The flags used for the transfer (eg FRAMEBUFFER_TRANSFER_DMA)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Not all framebuffer devices support mark, returns ERROR_CALL_NOT_IMPLEMENTED if not supported. Devices that support and require mark should set the flag FRAMEBUFFER_FLAG_MARK.

Framebuffer	The framebuffer device to commit
Address	The starting address of the commit
Size	The size in bytes of the commit
Flags	The flags used for the transfer (eg FRAMEBUFFER_TRANSFER_DMA)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Not all framebuffer devices support commit, returns ERROR_CALL_NOT_IMPLEMENTED if not supported. Devices that support and require commit should set the flag FRAMEBUFFER_FLAG_COMMIT.

Framebuffer	The framebuffer device to get from
X	The starting column of the get
Y	The starting row of the get
Buffer	Pointer to a block of memory large enough to hold the pixels in a contiguous block of rows
Width	The number of columns to get
Height	The number of rows to get
Skip	The number of pixels to skip in the buffer after each row (Optional)
Flags	The flags for the transfer (eg FRAMEBUFFER_TRANSFER_DMA)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Pixel data will be returned in the color format of the framebuffer. The default method assumes that framebuffer memory is DMA coherent and does not require cache cleaning before a DMA read.

Framebuffer	The framebuffer device to put to
X	The starting column of the put
Y	The starting row of the put
Buffer	Pointer to a block of memory containing the pixels in a contiguous block of rows
Width	The number of columns to put
Height	The number of rows to put
Skip	The number of pixels to skip in the buffer after each row (Optional)
Flags	The flags for the transfer (eg FRAMEBUFFER_TRANSFER_DMA)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Caller must ensure pixel data is in the correct color format for the framebuffer. The default method assumes that framebuffer memory is DMA coherent and does not require cache invalidation after a DMA write.

Frambuffer	The framebuffer device to copy on
X1	The starting column to copy from
Y1	The starting row to copy from
X2	The starting column to copy to
Y2	The starting row to copy to
Width	The number of columns to copy
Height	The number of rows to copy
Flags	The flags for the transfer (eg FRAMEBUFFER_TRANSFER_DMA)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	The default method assumes that framebuffer memory is DMA coherent and does not require cache clean/invalidate before or after a DMA read/write.

Frambuffer	The framebuffer device to fill on
X	The starting column of the fill
Y	The starting row of the fill
Width	The number of columns to fill
Height	The number of rows to fill
Color	The color to use for the fill
Flags	The flags for the transfer (eg FRAMEBUFFER_TRANSFER_DMA)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Color must be specified in the correct format for the framebuffer. The default method assumes that framebuffer memory is DMA coherent and does not require cache invalidation after a DMA write.

Framebuffer	The framebuffer device to get the start address from
Y	The row to get the start address of
Return	Pointer to the start address of the row or nil on failure

Framebuffer	The framebuffer device to get the address from
X	The column to get the start address of
Y	The row to get the start address of
Return	Pointer to the address of the row and column or nil on failure

Framebuffer	The framebuffer device to set the backlight
Brightness	The brightness value to set (Normally 0 to 100)
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Not all framebuffer devices support set backlight, returns ERROR_CALL_NOT_IMPLEMENTED if not supported. Devices that support set backlight should set the flag FRAMEBUFFER_FLAG_BACKLIGHT.

Size	Size in bytes to allocate for new Framebuffer (Including the Framebuffer entry)
Return	Pointer to new Framebuffer entry or nil if Framebuffer could not be created

Framebuffer	The framebuffer device to get properties from
Properties	Pointer to a TFramebufferProperties structure to return
Return	ERROR_SUCCESS if completed or another error code on failure

Framebuffer	The framebuffer device to set properties for
Properties	Pointer to a TFramebufferProperties structure containing the properties
Return	ERROR_SUCCESS if completed or another error code on failure
Note	Changing certain properties may cause the framebuffer to be reallocated