Type Number
Object BitmapPaint
Library display.*
Revision 2017.3075
See also BitmapPaint


This value is used to offset a repeating bitmap fill by a ratio of its width.

Instead of using a specific pixel value for this property, a value between -1 and 1 is required. This tells the GPU to offset the pattern by a full repetition in the horizontal direction. So, using 0.5 will shift the pattern half of one repetition distance on the x axis.

An important distinction is that setting a positive value will shift the pattern to the left, while a negative value will shift the object to the right.


-- Create a vector rectangle
local rect = display.newRect( 200, 200, 300, 300 )

-- Set the fill (paint) to use the bitmap image
local paint = {
    type = "image",
    filename = "texture1.png"

-- Fill the rectangle
rect.fill = paint

-- Offset the fill on the X axis
rect.fill.x = 1