3DCoat Python API
The 3DCoat Python API documentation.
Loading...
Searching...
No Matches
coat.Image Class Reference

Public Member Functions

 __init__ (self)
 
 __init__ (self, Image im)
 
bool Read (self, str name)
 Read the image from the file.
 
bool Write (self, str name)
 Write the image to file.
 
bool FromTexture (self, int texture_id)
 Get image from texture.
 
int ToTexture (self)
 Create texture from image.
 
int Paste (self, any src_data, int pasteLeft=0, int pasteTop=0, int cropLeft=0, int cropTop=0, int cropRight=0, int cropBottom=0, bool flipY=False)
 paste image to image
 
int Pointer (self)
 Pointer to the data.
 
bool FromArray (self, any src_data)
 Get image from texture.
 
bool FromArray (self, any src_data)
 
bool FromArray (self, any src_data)
 

Protected Member Functions

any _py_buffer_info (self)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

coat.Image.__init__ ( self)

◆ __init__() [2/2]

coat.Image.__init__ ( self,
Image im )

Member Function Documentation

◆ _py_buffer_info()

any coat.Image._py_buffer_info ( self)
protected

◆ FromArray() [1/3]

bool coat.Image.FromArray ( self,
any src_data )

Get image from texture.

Returns
true if succeed

◆ FromArray() [2/3]

bool coat.Image.FromArray ( self,
any src_data )

◆ FromArray() [3/3]

bool coat.Image.FromArray ( self,
any src_data )

◆ FromTexture()

bool coat.Image.FromTexture ( self,
int texture_id )

Get image from texture.

Returns
true if succeed

◆ Paste()

int coat.Image.Paste ( self,
any src_data,
int pasteLeft = 0,
int pasteTop = 0,
int cropLeft = 0,
int cropTop = 0,
int cropRight = 0,
int cropBottom = 0,
bool flipY = False )

paste image to image

Returns
true if succeed

◆ Pointer()

int coat.Image.Pointer ( self)

Pointer to the data.

Returns
true if succeed

◆ Read()

bool coat.Image.Read ( self,
str name )

Read the image from the file.

Parameters
namethe image name
Returns
true if loaded successfully

◆ ToTexture()

int coat.Image.ToTexture ( self)

Create texture from image.

Returns
true if succeed

◆ Write()

bool coat.Image.Write ( self,
str name )

Write the image to file.

Parameters
namethe filename
Returns
true if succeed

The documentation for this class was generated from the following file: