import OCP.Image from typing import * from typing import Iterable as iterable from typing import Iterator as iterator from numpy import float64 _Shape = Tuple[int, ...] import OCP.Quantity import OCP.NCollection import OCP.TColStd import OCP.Standard import io import OCP.TCollection __all__ = [ "Image_PixMap", "Image_ColorBGR", "Image_ColorBGR32", "Image_ColorBGRA", "Image_ColorBGRAF", "Image_ColorBGRF", "Image_ColorRGB", "Image_ColorRGB32", "Image_ColorRGBA", "Image_ColorRGBAF", "Image_ColorRGBF", "Image_ColorRGF", "Image_CompressedFormat", "Image_CompressedPixMap", "Image_DDSParser", "Image_Diff", "Image_Format", "Image_AlienPixMap", "Image_PixMapData", "Image_SupportedFormats", "Image_Texture", "Image_VideoParams", "Image_VideoRecorder", "Image_CompressedFormat_NB", "Image_CompressedFormat_RGBA_S3TC_DXT1", "Image_CompressedFormat_RGBA_S3TC_DXT3", "Image_CompressedFormat_RGBA_S3TC_DXT5", "Image_CompressedFormat_RGB_S3TC_DXT1", "Image_CompressedFormat_UNKNOWN", "Image_Format_Alpha", "Image_Format_AlphaF", "Image_Format_BGR", "Image_Format_BGR32", "Image_Format_BGRA", "Image_Format_BGRAF", "Image_Format_BGRF", "Image_Format_Gray", "Image_Format_Gray16", "Image_Format_GrayF", "Image_Format_GrayF_half", "Image_Format_NB", "Image_Format_RGB", "Image_Format_RGB32", "Image_Format_RGBA", "Image_Format_RGBAF", "Image_Format_RGBAF_half", "Image_Format_RGBF", "Image_Format_RGF", "Image_Format_RGF_half", "Image_Format_UNKNOWN" ] class Image_PixMap(OCP.Standard.Standard_Transient): """ Class represents packed image plane.Class represents packed image plane. """ def ChangeData(self) -> int: """ Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.). """ def ChangeRawValue(self,theRow : int,theCol : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next. """ def ChangeRawValueXY(self,theX : int,theY : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order. """ def ChangeRawValueXYZ(self,theX : int,theY : int,theZ : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order. """ def ChangeRow(self,theRow : int) -> int: """ Return data pointer to requested row (first column). Indexation starts from 0. """ def ChangeSlice(self,theSlice : int) -> int: """ Return data pointer to requested 2D slice. Indexation starts from 0. """ def ChangeSliceRow(self,theSlice : int,theRow : int) -> int: """ Return data pointer to requested row (first column). Indexation starts from 0. """ def Clear(self) -> None: """ Method correctly deallocate internal buffer. """ @staticmethod def ColorFromRawPixel_s(theRawValue : int,theFormat : Image_Format,theToLinearize : bool=False) -> OCP.Quantity.Quantity_ColorRGBA: """ Convert raw pixel value into Quantity_ColorRGBA. This function is relatively slow. """ @staticmethod def ColorToRawPixel_s(theRawValue : int,theFormat : Image_Format,theColor : OCP.Quantity.Quantity_ColorRGBA,theToDeLinearize : bool=False) -> None: """ Set raw pixel value from Quantity_ColorRGBA. This function is relatively slow. """ @staticmethod def ConvertFromHalfFloat_s(theHalf : int) -> float: """ Convert 16-bit half-float value into 32-bit float (simple conversion). """ @staticmethod def ConvertToHalfFloat_s(theFloat : float) -> int: """ Convert 32-bit float value into IEEE-754 16-bit floating-point format without infinity: 1-5-10, exp-15, +-131008.0, +-6.1035156E-5, +-5.9604645E-8, 3.311 digits. """ def Data(self) -> int: """ Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.). """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ @staticmethod def DefaultAllocator_s() -> OCP.NCollection.NCollection_BaseAllocator: """ Return default image data allocator. """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def Depth(self) -> int: """ Return image depth in pixels. """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ @staticmethod def FlipY_s(theImage : Image_PixMap) -> bool: """ Reverse line order as it draws it from bottom to top. """ def Format(self) -> Image_Format: """ Return pixel format. """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def Height(self) -> int: """ Return image height in pixels. """ @staticmethod @overload def ImageFormatToString_s(theFormat : Image_Format) -> str: """ Return string representation of pixel format. Return string representation of compressed pixel format. """ @staticmethod @overload def ImageFormatToString_s(theFormat : Image_CompressedFormat) -> str: ... def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ def InitCopy(self,theCopy : Image_PixMap) -> bool: """ Initialize by copying data. If you want to copy alien data you should create wrapper using InitWrapper() before. """ def InitTrash(self,thePixelFormat : Image_Format,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0) -> bool: """ Initialize image plane with required dimensions. Memory will be left uninitialized (performance trick). """ def InitTrash3D(self,thePixelFormat : Image_Format,theSizeXYZ : Any,theSizeRowBytes : int=0) -> bool: """ Initialize 2D/3D image with required dimensions. Memory will be left uninitialized (performance trick). """ def InitWrapper(self,thePixelFormat : Image_Format,theDataPtr : int,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0) -> bool: """ Initialize image plane as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying. """ def InitWrapper3D(self,thePixelFormat : Image_Format,theDataPtr : int,theSizeXYZ : Any,theSizeRowBytes : int=0) -> bool: """ Initialize 2D/3D image as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying. """ def InitZero(self,thePixelFormat : Image_Format,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0,theValue : int=0) -> bool: """ Initialize image plane with required dimensions. Buffer will be zeroed (black color for most formats). """ def InitZero3D(self,thePixelFormat : Image_Format,theSizeXYZ : Any,theSizeRowBytes : int=0,theValue : int=0) -> bool: """ Initialize 2D/3D image with required dimensions. Buffer will be zeroed (black color for most formats). """ @staticmethod def IsBigEndianHost_s() -> bool: """ Determine Big-Endian at runtime """ def IsEmpty(self) -> bool: """ Return true if data is NULL. """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def IsTopDown(self) -> bool: """ Returns TRUE if image data is stored from Top to the Down. By default Bottom Up order is used instead (topmost scanlines starts from the bottom in memory). which is most image frameworks naturally support. """ def MaxRowAligmentBytes(self) -> int: """ Compute the maximal row alignment for current row size. """ def PixelColor(self,theX : int,theY : int,theToLinearize : bool=False) -> OCP.Quantity.Quantity_ColorRGBA: """ Returns the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue(). """ def Ratio(self) -> float: """ Return width / height. """ def RawValue(self,theRow : int,theCol : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next. """ def RawValueXY(self,theX : int,theY : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order. """ def RawValueXYZ(self,theX : int,theY : int,theZ : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order. """ def Row(self,theRow : int) -> int: """ Return data pointer to requested row (first column). Indexation starts from 0. """ def RowExtraBytes(self) -> int: """ Return the extra bytes in the row. """ def SetFormat(self,thePixelFormat : Image_Format) -> None: """ Override pixel format specified by InitXXX() methods. Will throw exception if pixel size of new format is not equal to currently initialized format. Intended to switch formats indicating different interpretation of the same data (e.g. ImgGray and ImgAlpha). """ @overload def SetPixelColor(self,theX : int,theY : int,theColor : OCP.Quantity.Quantity_ColorRGBA,theToDeLinearize : bool=False) -> None: """ Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue(). Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue(). """ @overload def SetPixelColor(self,theX : int,theY : int,theColor : OCP.Quantity.Quantity_Color,theToDeLinearize : bool=False) -> None: ... def SetTopDown(self,theIsTopDown : bool) -> None: """ Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored! """ def SizeBytes(self) -> int: """ Return buffer size """ def SizePixelBytes(self) -> int: """ Return bytes reserved for one pixel (may include extra bytes for alignment). """ @staticmethod def SizePixelBytes_s(thePixelFormat : Image_Format) -> int: """ Return bytes reserved for one pixel (may include extra bytes for alignment). """ def SizeRowBytes(self) -> int: """ Return bytes reserved per row. Could be larger than needed to store packed row (extra bytes for alignment etc.). """ def SizeSliceBytes(self) -> int: """ Return number of bytes per 2D slice. """ def SizeX(self) -> int: """ Return image width in pixels. """ def SizeXYZ(self) -> Any: """ Return image width x height x depth in pixels. """ def SizeY(self) -> int: """ Return image height in pixels. """ def SizeZ(self) -> int: """ Return image depth in pixels. """ def Slice(self,theSlice : int) -> int: """ Return data pointer to requested 2D slice. Indexation starts from 0. """ def SliceRow(self,theSlice : int,theRow : int) -> int: """ Return data pointer to requested row (first column). Indexation starts from 0. """ @staticmethod def SwapRgbaBgra_s(theImage : Image_PixMap) -> bool: """ Auxiliary method for swapping bytes between RGB and BGR formats. This method modifies the image data but does not change pixel format! Method will fail if pixel format is not one of the following: - Image_Format_RGB32 / Image_Format_BGR32 - Image_Format_RGBA / Image_Format_BGRA - Image_Format_RGB / Image_Format_BGR - Image_Format_RGBF / Image_Format_BGRF - Image_Format_RGBAF / Image_Format_BGRAF """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ @staticmethod def ToBlackWhite_s(theImage : Image_PixMap) -> None: """ Convert image to Black/White. """ def TopDownInc(self) -> int: """ Returns +1 if scanlines ordered in Top->Down order in memory and -1 otherwise. """ def Width(self) -> int: """ Return image width in pixels. """ def __init__(self) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class Image_ColorBGR(): """ POD structure for packed BGR color value (3 bytes) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def b(self) -> int: """ Alias to 1st component (blue intensity). Alias to 1st component (blue intensity). """ def g(self) -> int: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> int: """ Alias to 3rd component (red intensity). Alias to 3rd component (red intensity). """ pass class Image_ColorBGR32(): """ POD structure for packed BGR color value (4 bytes with extra byte for alignment) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def a_(self) -> int: """ Alias to 4th component (dummy). Alias to 4th component (dummy). """ def b(self) -> int: """ Alias to 1st component (blue intensity). Alias to 1st component (blue intensity). """ def g(self) -> int: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> int: """ Alias to 3rd component (red intensity). Alias to 3rd component (red intensity). """ pass class Image_ColorBGRA(): """ POD structure for packed BGRA color value (4 bytes) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def a(self) -> int: """ Alias to 4th component (alpha value). Alias to 4th component (alpha value). """ def b(self) -> int: """ Alias to 1st component (blue intensity). Alias to 1st component (blue intensity). """ def g(self) -> int: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> int: """ Alias to 3rd component (red intensity). Alias to 3rd component (red intensity). """ pass class Image_ColorBGRAF(): """ POD structure for packed float BGRA color value (4 floats) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def a(self) -> float: """ Alias to 4th component (alpha value). Alias to 4th component (alpha value). """ def b(self) -> float: """ Alias to 1st component (blue intensity). Alias to 1st component (blue intensity). """ def g(self) -> float: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> float: """ Alias to 3rd component (red intensity). Alias to 3rd component (red intensity). """ pass class Image_ColorBGRF(): """ POD structure for packed BGR float color value (3 floats) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def b(self) -> float: """ Alias to 1st component (blue intensity). Alias to 1st component (blue intensity). """ def g(self) -> float: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> float: """ Alias to 3rd component (red intensity). Alias to 3rd component (red intensity). """ pass class Image_ColorRGB(): """ POD structure for packed RGB color value (3 bytes) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def b(self) -> int: """ Alias to 3rd component (blue intensity). Alias to 3rd component (blue intensity). """ def g(self) -> int: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> int: """ Alias to 1st component (red intensity). Alias to 1st component (red intensity). """ pass class Image_ColorRGB32(): """ POD structure for packed RGB color value (4 bytes with extra byte for alignment) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def a_(self) -> int: """ Alias to 4th component (dummy). Alias to 4th component (dummy). """ def b(self) -> int: """ Alias to 3rd component (blue intensity). Alias to 3rd component (blue intensity). """ def g(self) -> int: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> int: """ Alias to 1st component (red intensity). Alias to 1st component (red intensity). """ pass class Image_ColorRGBA(): """ POD structure for packed RGBA color value (4 bytes) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def a(self) -> int: """ Alias to 4th component (alpha value). Alias to 4th component (alpha value). """ def b(self) -> int: """ Alias to 3rd component (blue intensity). Alias to 3rd component (blue intensity). """ def g(self) -> int: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> int: """ Alias to 1st component (red intensity). Alias to 1st component (red intensity). """ pass class Image_ColorRGBAF(): """ POD structure for packed RGBA color value (4 floats) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def a(self) -> float: """ Alias to 4th component (alpha value). Alias to 4th component (alpha value). """ def b(self) -> float: """ Alias to 3rd component (blue intensity). Alias to 3rd component (blue intensity). """ def g(self) -> float: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> float: """ Alias to 1st component (red intensity). Alias to 1st component (red intensity). """ pass class Image_ColorRGBF(): """ POD structure for packed float RGB color value (3 floats) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def b(self) -> float: """ Alias to 3rd component (blue intensity). Alias to 3rd component (blue intensity). """ def g(self) -> float: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> float: """ Alias to 1st component (red intensity). Alias to 1st component (red intensity). """ pass class Image_ColorRGF(): """ POD structure for packed float RG color value (2 floats) """ @staticmethod def Length_s() -> int: """ Returns the number of components. """ def __init__(self) -> None: ... def g(self) -> float: """ Alias to 2nd component (green intensity). Alias to 2nd component (green intensity). """ def r(self) -> float: """ Alias to 1st component (red intensity). Alias to 1st component (red intensity). """ pass class Image_CompressedFormat(): """ List of compressed pixel formats natively supported by various graphics hardware (e.g. for efficient decoding on-the-fly). It is defined as extension of Image_Format. Members: Image_CompressedFormat_UNKNOWN Image_CompressedFormat_RGB_S3TC_DXT1 Image_CompressedFormat_RGBA_S3TC_DXT1 Image_CompressedFormat_RGBA_S3TC_DXT3 Image_CompressedFormat_RGBA_S3TC_DXT5 """ def __eq__(self,other : object) -> bool: ... def __getstate__(self) -> int: ... def __hash__(self) -> int: ... def __index__(self) -> int: ... def __init__(self,value : int) -> None: ... def __int__(self) -> int: ... def __ne__(self,other : object) -> bool: ... def __repr__(self) -> str: ... def __setstate__(self,state : int) -> None: ... def __str__(self) -> str: ... @property def name(self) -> None: """ :type: None """ @property def value(self) -> int: """ :type: int """ Image_CompressedFormat_RGBA_S3TC_DXT1: OCP.Image.Image_CompressedFormat # value = Image_CompressedFormat_RGBA_S3TC_DXT3: OCP.Image.Image_CompressedFormat # value = Image_CompressedFormat_RGBA_S3TC_DXT5: OCP.Image.Image_CompressedFormat # value = Image_CompressedFormat_RGB_S3TC_DXT1: OCP.Image.Image_CompressedFormat # value = Image_CompressedFormat_UNKNOWN: OCP.Image.Image_CompressedFormat # value = __entries: dict # value = {'Image_CompressedFormat_UNKNOWN': (, None), 'Image_CompressedFormat_RGB_S3TC_DXT1': (, None), 'Image_CompressedFormat_RGBA_S3TC_DXT1': (, None), 'Image_CompressedFormat_RGBA_S3TC_DXT3': (, None), 'Image_CompressedFormat_RGBA_S3TC_DXT5': (, None)} __members__: dict # value = {'Image_CompressedFormat_UNKNOWN': , 'Image_CompressedFormat_RGB_S3TC_DXT1': , 'Image_CompressedFormat_RGBA_S3TC_DXT1': , 'Image_CompressedFormat_RGBA_S3TC_DXT3': , 'Image_CompressedFormat_RGBA_S3TC_DXT5': } pass class Image_CompressedPixMap(OCP.Standard.Standard_Transient): """ Compressed pixmap data definition. It is defined independently from Image_PixMap, which defines only uncompressed formats. """ def BaseFormat(self) -> Image_Format: """ Return base (uncompressed) pixel format. """ def ChangeMipMaps(self) -> OCP.TColStd.TColStd_Array1OfInteger: """ Return Array of mipmap sizes, including base level. """ def CompressedFormat(self) -> Image_CompressedFormat: """ Return compressed format. """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def FaceBytes(self) -> int: """ Return surface length in bytes. """ def FaceData(self) -> OCP.NCollection.NCollection_Buffer: """ Return raw (compressed) data. """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ def IsCompleteMipMapSet(self) -> bool: """ Return TRUE if complete mip map level set (up to 1x1 resolution). """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def IsTopDown(self) -> bool: """ Return TRUE if image layout is top-down (always true). """ def MipMaps(self) -> OCP.TColStd.TColStd_Array1OfInteger: """ Return Array of mipmap sizes, including base level. """ def NbFaces(self) -> int: """ Return number of faces in the file; should be 6 for cubemap. """ def SetBaseFormat(self,theFormat : Image_Format) -> None: """ Set base (uncompressed) pixel format. """ def SetCompleteMipMapSet(self,theIsComplete : bool) -> None: """ Set if complete mip map level set (up to 1x1 resolution). """ def SetCompressedFormat(self,theFormat : Image_CompressedFormat) -> None: """ Set compressed format. """ def SetFaceBytes(self,theSize : int) -> None: """ Set surface length in bytes. """ def SetFaceData(self,theBuffer : OCP.NCollection.NCollection_Buffer) -> None: """ Set raw (compressed) data. """ def SetNbFaces(self,theSize : int) -> None: """ Set number of faces in the file. """ def SetSize(self,theSizeX : int,theSizeY : int) -> None: """ Set surface width x height. """ def SizeX(self) -> int: """ Return surface width. """ def SizeY(self) -> int: """ Return surface height. """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def __init__(self) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class Image_DDSParser(): """ Auxiliary tool for parsing DDS file structure (without decoding). """ @staticmethod @overload def Load_s(theSupported : Image_SupportedFormats,theBuffer : OCP.NCollection.NCollection_Buffer,theFaceIndex : int) -> Image_CompressedPixMap: """ Load the face from DDS file. Load the face from DDS file. """ @staticmethod @overload def Load_s(theSupported : Image_SupportedFormats,theFile : OCP.TCollection.TCollection_AsciiString,theFaceIndex : int,theFileOffset : int=0) -> Image_CompressedPixMap: ... def __init__(self) -> None: ... pass class Image_Diff(OCP.Standard.Standard_Transient): """ This class compares two images pixel-by-pixel. It uses the following methods to ignore the difference between images: - Black/White comparison. It makes the images 2-colored before the comparison. - Equality with tolerance. Colors of two pixels are considered the same if the difference of their color is less than a tolerance. - Border filter. The algorithm ignores alone independent pixels, which are different on both images, ignores the "border effect" - the difference caused by triangles located at angle about 0 or 90 degrees to the user.This class compares two images pixel-by-pixel. It uses the following methods to ignore the difference between images: - Black/White comparison. It makes the images 2-colored before the comparison. - Equality with tolerance. Colors of two pixels are considered the same if the difference of their color is less than a tolerance. - Border filter. The algorithm ignores alone independent pixels, which are different on both images, ignores the "border effect" - the difference caused by triangles located at angle about 0 or 90 degrees to the user. """ def ColorTolerance(self) -> float: """ Color tolerance for equality check. """ def Compare(self) -> int: """ Compares two images. It returns a number of different pixels (or groups of pixels). It returns -1 if algorithm not initialized before. """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ @overload def Init(self,theImgPathRef : OCP.TCollection.TCollection_AsciiString,theImgPathNew : OCP.TCollection.TCollection_AsciiString,theToBlackWhite : bool=False) -> bool: """ Initialize algorithm by two images. Initialize algorithm by two images (will be loaded from files). """ @overload def Init(self,theImageRef : Image_PixMap,theImageNew : Image_PixMap,theToBlackWhite : bool=False) -> bool: ... def IsBorderFilterOn(self) -> bool: """ Returns a flag of taking into account (ignoring) a border effect in comparison of images. """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... @overload def SaveDiffImage(self,theDiffPath : OCP.TCollection.TCollection_AsciiString) -> bool: """ Saves a difference between two images as white pixels on black background. Saves a difference between two images as white pixels on black background. """ @overload def SaveDiffImage(self,theDiffImage : Image_PixMap) -> bool: ... def SetBorderFilterOn(self,theToIgnore : bool) -> None: """ Sets taking into account (ignoring) a "border effect" on comparison of images. The border effect is caused by a border of shaded shapes in the viewer 3d. Triangles of this area are located at about 0 or 90 degrees to the user. Therefore, they deflect light differently according to implementation of a video card driver. This flag allows to detect such a "border" area and skip it from comparison of images. Filter turned OFF by default. """ def SetColorTolerance(self,theTolerance : float) -> None: """ Color tolerance for equality check. Should be within range 0..1: Corresponds to a difference between white and black colors (maximum difference). By default, the tolerance is equal to 0 thus equality check will return false for any different colors. """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def __init__(self) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class Image_Format(): """ This enumeration defines packed image plane formats Members: Image_Format_UNKNOWN Image_Format_Gray Image_Format_Alpha Image_Format_RGB Image_Format_BGR Image_Format_RGB32 Image_Format_BGR32 Image_Format_RGBA Image_Format_BGRA Image_Format_GrayF Image_Format_AlphaF Image_Format_RGF Image_Format_RGBF Image_Format_BGRF Image_Format_RGBAF Image_Format_BGRAF Image_Format_GrayF_half Image_Format_RGF_half Image_Format_RGBAF_half Image_Format_Gray16 """ def __eq__(self,other : object) -> bool: ... def __getstate__(self) -> int: ... def __hash__(self) -> int: ... def __index__(self) -> int: ... def __init__(self,value : int) -> None: ... def __int__(self) -> int: ... def __ne__(self,other : object) -> bool: ... def __repr__(self) -> str: ... def __setstate__(self,state : int) -> None: ... def __str__(self) -> str: ... @property def name(self) -> None: """ :type: None """ @property def value(self) -> int: """ :type: int """ Image_Format_Alpha: OCP.Image.Image_Format # value = Image_Format_AlphaF: OCP.Image.Image_Format # value = Image_Format_BGR: OCP.Image.Image_Format # value = Image_Format_BGR32: OCP.Image.Image_Format # value = Image_Format_BGRA: OCP.Image.Image_Format # value = Image_Format_BGRAF: OCP.Image.Image_Format # value = Image_Format_BGRF: OCP.Image.Image_Format # value = Image_Format_Gray: OCP.Image.Image_Format # value = Image_Format_Gray16: OCP.Image.Image_Format # value = Image_Format_GrayF: OCP.Image.Image_Format # value = Image_Format_GrayF_half: OCP.Image.Image_Format # value = Image_Format_RGB: OCP.Image.Image_Format # value = Image_Format_RGB32: OCP.Image.Image_Format # value = Image_Format_RGBA: OCP.Image.Image_Format # value = Image_Format_RGBAF: OCP.Image.Image_Format # value = Image_Format_RGBAF_half: OCP.Image.Image_Format # value = Image_Format_RGBF: OCP.Image.Image_Format # value = Image_Format_RGF: OCP.Image.Image_Format # value = Image_Format_RGF_half: OCP.Image.Image_Format # value = Image_Format_UNKNOWN: OCP.Image.Image_Format # value = __entries: dict # value = {'Image_Format_UNKNOWN': (, None), 'Image_Format_Gray': (, None), 'Image_Format_Alpha': (, None), 'Image_Format_RGB': (, None), 'Image_Format_BGR': (, None), 'Image_Format_RGB32': (, None), 'Image_Format_BGR32': (, None), 'Image_Format_RGBA': (, None), 'Image_Format_BGRA': (, None), 'Image_Format_GrayF': (, None), 'Image_Format_AlphaF': (, None), 'Image_Format_RGF': (, None), 'Image_Format_RGBF': (, None), 'Image_Format_BGRF': (, None), 'Image_Format_RGBAF': (, None), 'Image_Format_BGRAF': (, None), 'Image_Format_GrayF_half': (, None), 'Image_Format_RGF_half': (, None), 'Image_Format_RGBAF_half': (, None), 'Image_Format_Gray16': (, None)} __members__: dict # value = {'Image_Format_UNKNOWN': , 'Image_Format_Gray': , 'Image_Format_Alpha': , 'Image_Format_RGB': , 'Image_Format_BGR': , 'Image_Format_RGB32': , 'Image_Format_BGR32': , 'Image_Format_RGBA': , 'Image_Format_BGRA': , 'Image_Format_GrayF': , 'Image_Format_AlphaF': , 'Image_Format_RGF': , 'Image_Format_RGBF': , 'Image_Format_BGRF': , 'Image_Format_RGBAF': , 'Image_Format_BGRAF': , 'Image_Format_GrayF_half': , 'Image_Format_RGF_half': , 'Image_Format_RGBAF_half': , 'Image_Format_Gray16': } pass class Image_AlienPixMap(Image_PixMap, OCP.Standard.Standard_Transient): """ Image class that support file reading/writing operations using auxiliary image library. Supported image formats: - *.bmp - bitmap image, lossless format without compression. - *.ppm - PPM (Portable Pixmap Format), lossless format without compression. - *.png - PNG (Portable Network Graphics) lossless format with compression. - *.jpg, *.jpe, *.jpeg - JPEG/JIFF (Joint Photographic Experts Group) lossy format (compressed with quality losses). YUV color space used (automatically converted from/to RGB). - *.tif, *.tiff - TIFF (Tagged Image File Format). - *.tga - TGA (Truevision Targa Graphic), lossless format. - *.gif - GIF (Graphical Interchange Format), lossy format. Color stored using palette (up to 256 distinct colors). - *.exr - OpenEXR high dynamic-range format (supports float pixel formats).Image class that support file reading/writing operations using auxiliary image library. Supported image formats: - *.bmp - bitmap image, lossless format without compression. - *.ppm - PPM (Portable Pixmap Format), lossless format without compression. - *.png - PNG (Portable Network Graphics) lossless format with compression. - *.jpg, *.jpe, *.jpeg - JPEG/JIFF (Joint Photographic Experts Group) lossy format (compressed with quality losses). YUV color space used (automatically converted from/to RGB). - *.tif, *.tiff - TIFF (Tagged Image File Format). - *.tga - TGA (Truevision Targa Graphic), lossless format. - *.gif - GIF (Graphical Interchange Format), lossy format. Color stored using palette (up to 256 distinct colors). - *.exr - OpenEXR high dynamic-range format (supports float pixel formats). """ def AdjustGamma(self,theGammaCorr : float) -> bool: """ Performs gamma correction on image. """ def ChangeData(self) -> int: """ Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.). """ def ChangeRawValue(self,theRow : int,theCol : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next. """ def ChangeRawValueXY(self,theX : int,theY : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order. """ def ChangeRawValueXYZ(self,theX : int,theY : int,theZ : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order. """ def ChangeRow(self,theRow : int) -> int: """ Return data pointer to requested row (first column). Indexation starts from 0. """ def ChangeSlice(self,theSlice : int) -> int: """ Return data pointer to requested 2D slice. Indexation starts from 0. """ def ChangeSliceRow(self,theSlice : int,theRow : int) -> int: """ Return data pointer to requested row (first column). Indexation starts from 0. """ def Clear(self) -> None: """ Method correctly deallocate internal buffer. """ @staticmethod def ColorFromRawPixel_s(theRawValue : int,theFormat : Image_Format,theToLinearize : bool=False) -> OCP.Quantity.Quantity_ColorRGBA: """ Convert raw pixel value into Quantity_ColorRGBA. This function is relatively slow. """ @staticmethod def ColorToRawPixel_s(theRawValue : int,theFormat : Image_Format,theColor : OCP.Quantity.Quantity_ColorRGBA,theToDeLinearize : bool=False) -> None: """ Set raw pixel value from Quantity_ColorRGBA. This function is relatively slow. """ @staticmethod def ConvertFromHalfFloat_s(theHalf : int) -> float: """ Convert 16-bit half-float value into 32-bit float (simple conversion). """ @staticmethod def ConvertToHalfFloat_s(theFloat : float) -> int: """ Convert 32-bit float value into IEEE-754 16-bit floating-point format without infinity: 1-5-10, exp-15, +-131008.0, +-6.1035156E-5, +-5.9604645E-8, 3.311 digits. """ def Data(self) -> int: """ Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.). """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ @staticmethod def DefaultAllocator_s() -> OCP.NCollection.NCollection_BaseAllocator: """ Return default image data allocator. """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def Depth(self) -> int: """ Return image depth in pixels. """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ @staticmethod def FlipY_s(theImage : Image_PixMap) -> bool: """ Reverse line order as it draws it from bottom to top. """ def Format(self) -> Image_Format: """ Return pixel format. """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def Height(self) -> int: """ Return image height in pixels. """ @staticmethod @overload def ImageFormatToString_s(theFormat : Image_Format) -> str: """ Return string representation of pixel format. Return string representation of compressed pixel format. """ @staticmethod @overload def ImageFormatToString_s(theFormat : Image_CompressedFormat) -> str: ... def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ def InitCopy(self,theCopy : Image_PixMap) -> bool: """ Initialize by copying data. """ def InitTrash(self,thePixelFormat : Image_Format,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0) -> bool: """ Initialize image plane with required dimensions. """ def InitTrash3D(self,thePixelFormat : Image_Format,theSizeXYZ : Any,theSizeRowBytes : int=0) -> bool: """ Initialize 2D/3D image with required dimensions. Memory will be left uninitialized (performance trick). """ def InitWrapper(self,thePixelFormat : Image_Format,theDataPtr : int,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0) -> bool: """ Initialize image plane as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying. """ def InitWrapper3D(self,thePixelFormat : Image_Format,theDataPtr : int,theSizeXYZ : Any,theSizeRowBytes : int=0) -> bool: """ Initialize 2D/3D image as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying. """ def InitZero(self,thePixelFormat : Image_Format,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0,theValue : int=0) -> bool: """ Initialize image plane with required dimensions. Buffer will be zeroed (black color for most formats). """ def InitZero3D(self,thePixelFormat : Image_Format,theSizeXYZ : Any,theSizeRowBytes : int=0,theValue : int=0) -> bool: """ Initialize 2D/3D image with required dimensions. Buffer will be zeroed (black color for most formats). """ @staticmethod def IsBigEndianHost_s() -> bool: """ Determine Big-Endian at runtime """ def IsEmpty(self) -> bool: """ Return true if data is NULL. """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def IsTopDown(self) -> bool: """ Returns TRUE if image data is stored from Top to the Down. By default Bottom Up order is used instead (topmost scanlines starts from the bottom in memory). which is most image frameworks naturally support. """ @staticmethod def IsTopDownDefault_s() -> bool: """ Return default rows order used by underlying image library. """ def MaxRowAligmentBytes(self) -> int: """ Compute the maximal row alignment for current row size. """ def PixelColor(self,theX : int,theY : int,theToLinearize : bool=False) -> OCP.Quantity.Quantity_ColorRGBA: """ Returns the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue(). """ def Ratio(self) -> float: """ Return width / height. """ def RawValue(self,theRow : int,theCol : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next. """ def RawValueXY(self,theX : int,theY : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order. """ def RawValueXYZ(self,theX : int,theY : int,theZ : int) -> int: """ Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order. """ def Row(self,theRow : int) -> int: """ Return data pointer to requested row (first column). Indexation starts from 0. """ def RowExtraBytes(self) -> int: """ Return the extra bytes in the row. """ @overload def Save(self,theFileName : OCP.TCollection.TCollection_AsciiString) -> bool: """ Write image data to file. Write image data to stream. Write image data to file or memory buffer using file extension to determine format. """ @overload def Save(self,theBuffer : int,theLength : int,theFileName : OCP.TCollection.TCollection_AsciiString) -> bool: ... @overload def Save(self,theStream : io.BytesIO,theExtension : OCP.TCollection.TCollection_AsciiString) -> bool: ... def SetFormat(self,thePixelFormat : Image_Format) -> None: """ Override pixel format specified by InitXXX() methods. Will throw exception if pixel size of new format is not equal to currently initialized format. Intended to switch formats indicating different interpretation of the same data (e.g. ImgGray and ImgAlpha). """ @overload def SetPixelColor(self,theX : int,theY : int,theColor : OCP.Quantity.Quantity_ColorRGBA,theToDeLinearize : bool=False) -> None: """ Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue(). Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue(). """ @overload def SetPixelColor(self,theX : int,theY : int,theColor : OCP.Quantity.Quantity_Color,theToDeLinearize : bool=False) -> None: ... def SetTopDown(self,theIsTopDown : bool) -> None: """ Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored! """ def SizeBytes(self) -> int: """ Return buffer size """ def SizePixelBytes(self) -> int: """ Return bytes reserved for one pixel (may include extra bytes for alignment). """ @staticmethod def SizePixelBytes_s(thePixelFormat : Image_Format) -> int: """ Return bytes reserved for one pixel (may include extra bytes for alignment). """ def SizeRowBytes(self) -> int: """ Return bytes reserved per row. Could be larger than needed to store packed row (extra bytes for alignment etc.). """ def SizeSliceBytes(self) -> int: """ Return number of bytes per 2D slice. """ def SizeX(self) -> int: """ Return image width in pixels. """ def SizeXYZ(self) -> Any: """ Return image width x height x depth in pixels. """ def SizeY(self) -> int: """ Return image height in pixels. """ def SizeZ(self) -> int: """ Return image depth in pixels. """ def Slice(self,theSlice : int) -> int: """ Return data pointer to requested 2D slice. Indexation starts from 0. """ def SliceRow(self,theSlice : int,theRow : int) -> int: """ Return data pointer to requested row (first column). Indexation starts from 0. """ @staticmethod def SwapRgbaBgra_s(theImage : Image_PixMap) -> bool: """ Auxiliary method for swapping bytes between RGB and BGR formats. This method modifies the image data but does not change pixel format! Method will fail if pixel format is not one of the following: - Image_Format_RGB32 / Image_Format_BGR32 - Image_Format_RGBA / Image_Format_BGRA - Image_Format_RGB / Image_Format_BGR - Image_Format_RGBF / Image_Format_BGRF - Image_Format_RGBAF / Image_Format_BGRAF """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ @staticmethod def ToBlackWhite_s(theImage : Image_PixMap) -> None: """ Convert image to Black/White. """ def TopDownInc(self) -> int: """ Returns +1 if scanlines ordered in Top->Down order in memory and -1 otherwise. """ def Width(self) -> int: """ Return image width in pixels. """ def __init__(self) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class Image_PixMapData(OCP.NCollection.NCollection_Buffer, OCP.Standard.Standard_Transient): """ Structure to manage image buffer.Structure to manage image buffer. """ def Allocate(self,theSize : int) -> bool: """ Allocate the buffer. """ def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator: """ Returns buffer allocator """ def ChangeData(self) -> int: """ Returns buffer data """ def ChangeRow(self,theRow : int) -> int: """ Return data pointer to requested row (first column). """ def ChangeSlice(self,theSlice : int) -> int: """ Return data pointer to requested 2D slice. """ def ChangeSliceRow(self,theSlice : int,theRow : int) -> int: """ Return data pointer to requested row (first column). """ def ChangeValue(self,theRow : int,theCol : int) -> int: """ Return data pointer to requested position. """ def ChangeValueXY(self,theX : int,theY : int) -> int: """ Return data pointer to requested position. """ def ChangeValueXYZ(self,theX : int,theY : int,theZ : int) -> int: """ Return data pointer to requested position. """ def Data(self) -> int: """ Returns buffer data """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DumpJson(self,theOStream : io.BytesIO,theDepth : int=-1) -> None: """ Dumps the content of me into the stream """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def Free(self) -> None: """ De-allocate buffer. """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ @overload def Init(self,theAlloc : OCP.NCollection.NCollection_BaseAllocator,theSizeBPP : int,theSizeXYZ : Any,theSizeRowBytes : int,theDataPtr : int) -> bool: """ Initializer. Initializer. """ @overload def Init(self,theAlloc : OCP.NCollection.NCollection_BaseAllocator,theSizeBPP : int,theSizeX : int,theSizeY : int,theSizeRowBytes : int,theDataPtr : int) -> bool: ... def IsEmpty(self) -> bool: """ Returns true if buffer is not allocated """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def MaxRowAligmentBytes(self) -> int: """ Compute the maximal row alignment for current row size. """ def Row(self,theRow : int) -> int: """ Return data pointer to requested row (first column). """ def SetAllocator(self,theAlloc : OCP.NCollection.NCollection_BaseAllocator) -> None: """ Assign new buffer allocator with de-allocation of buffer. """ def SetTopDown(self,theIsTopDown : bool) -> None: """ Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored! """ def Size(self) -> int: """ Return buffer length in bytes. """ def Slice(self,theSlice : int) -> int: """ Return data pointer to requested 2D slice. """ def SliceRow(self,theSlice : int,theRow : int) -> int: """ Return data pointer to requested row (first column). """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def Value(self,theRow : int,theCol : int) -> int: """ Return data pointer to requested position. """ def ValueXY(self,theX : int,theY : int) -> int: """ Return data pointer to requested position. """ def ValueXYZ(self,theX : int,theY : int,theZ : int) -> int: """ Return data pointer to requested position. """ def ZeroData(self) -> None: """ Reset all values to zeros. """ def __init__(self) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ @property def SizeBPP(self) -> int: """ :type: int """ @SizeBPP.setter def SizeBPP(self, arg0: int) -> None: pass @property def SizeRowBytes(self) -> int: """ :type: int """ @SizeRowBytes.setter def SizeRowBytes(self, arg0: int) -> None: pass @property def SizeSliceBytes(self) -> int: """ :type: int """ @SizeSliceBytes.setter def SizeSliceBytes(self, arg0: int) -> None: pass @property def SizeX(self) -> int: """ :type: int """ @SizeX.setter def SizeX(self, arg0: int) -> None: pass @property def SizeY(self) -> int: """ :type: int """ @SizeY.setter def SizeY(self, arg0: int) -> None: pass @property def SizeZ(self) -> int: """ :type: int """ @SizeZ.setter def SizeZ(self, arg0: int) -> None: pass @property def TopToDown(self) -> int: """ :type: int """ @TopToDown.setter def TopToDown(self, arg0: int) -> None: pass pass class Image_SupportedFormats(OCP.Standard.Standard_Transient): """ Structure holding information about supported texture formats. """ @overload def Add(self,theFormat : Image_Format) -> None: """ Set if image format is supported or not. Set if compressed image format is supported or not. """ @overload def Add(self,theFormat : Image_CompressedFormat) -> None: ... def Clear(self) -> None: """ Reset flags. """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def HasCompressed(self) -> bool: """ Return TRUE if there are compressed image formats supported. """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... @overload def IsSupported(self,theFormat : Image_Format) -> bool: """ Return TRUE if image format is supported. Return TRUE if compressed image format is supported. """ @overload def IsSupported(self,theFormat : Image_CompressedFormat) -> bool: ... def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def __init__(self) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class Image_Texture(OCP.Standard.Standard_Transient): """ Texture image definition. The image can be stored as path to image file, as file path with the given offset and as a data buffer of encoded image. """ def DataBuffer(self) -> OCP.NCollection.NCollection_Buffer: """ Return buffer holding encoded image content. """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DumpJson(self,theOStream : io.BytesIO,theDepth : int=-1) -> None: """ Dumps the content of me into the stream """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def FileLength(self) -> int: """ Return length of image data within the file after offset. """ def FileOffset(self) -> int: """ Return offset within file. """ def FilePath(self) -> OCP.TCollection.TCollection_AsciiString: """ Return image file path. """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def MimeType(self) -> OCP.TCollection.TCollection_AsciiString: """ Return mime-type of image file based on ProbeImageFileFormat(). """ def ProbeImageFileFormat(self) -> OCP.TCollection.TCollection_AsciiString: """ Return image file format. """ def ReadCompressedImage(self,theSupported : Image_SupportedFormats) -> Image_CompressedPixMap: """ Image reader without decoding data for formats supported natively by GPUs. """ def ReadImage(self,theSupported : Image_SupportedFormats) -> Image_PixMap: """ Image reader. """ def TextureId(self) -> OCP.TCollection.TCollection_AsciiString: """ Return generated texture id. """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ @overload def WriteImage(self,theFile : OCP.TCollection.TCollection_AsciiString) -> bool: """ Write image to specified file without decoding data. Write image to specified stream without decoding data. """ @overload def WriteImage(self,theStream : io.BytesIO,theFile : OCP.TCollection.TCollection_AsciiString) -> bool: ... @overload def __init__(self,theBuffer : OCP.NCollection.NCollection_Buffer,theId : OCP.TCollection.TCollection_AsciiString) -> None: ... @overload def __init__(self,theFileName : OCP.TCollection.TCollection_AsciiString) -> None: ... @overload def __init__(self,theFileName : OCP.TCollection.TCollection_AsciiString,theOffset : int,theLength : int) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass class Image_VideoParams(): """ Auxiliary structure defining video parameters. Please refer to FFmpeg documentation for defining text values. """ @overload def SetFramerate(self,theNumerator : int,theDenominator : int) -> None: """ Setup playback FPS. Setup playback FPS. For fixed-fps content, timebase should be 1/framerate and timestamp increments should be identical to 1. """ @overload def SetFramerate(self,theValue : int) -> None: ... def __init__(self) -> None: ... @property def Format(self) -> OCP.TCollection.TCollection_AsciiString: """ :type: OCP.TCollection.TCollection_AsciiString """ @Format.setter def Format(self, arg0: OCP.TCollection.TCollection_AsciiString) -> None: pass @property def FpsDen(self) -> int: """ :type: int """ @FpsDen.setter def FpsDen(self, arg0: int) -> None: pass @property def FpsNum(self) -> int: """ :type: int """ @FpsNum.setter def FpsNum(self, arg0: int) -> None: pass @property def Height(self) -> int: """ :type: int """ @Height.setter def Height(self, arg0: int) -> None: pass @property def PixelFormat(self) -> OCP.TCollection.TCollection_AsciiString: """ :type: OCP.TCollection.TCollection_AsciiString """ @PixelFormat.setter def PixelFormat(self, arg0: OCP.TCollection.TCollection_AsciiString) -> None: pass @property def VideoCodec(self) -> OCP.TCollection.TCollection_AsciiString: """ :type: OCP.TCollection.TCollection_AsciiString """ @VideoCodec.setter def VideoCodec(self, arg0: OCP.TCollection.TCollection_AsciiString) -> None: pass @property def VideoCodecParams(self) -> OCP.Resource.Resource_DataMapOfAsciiStringAsciiString: """ :type: OCP.Resource.Resource_DataMapOfAsciiStringAsciiString """ @VideoCodecParams.setter def VideoCodecParams(self, arg0: OCP.Resource.Resource_DataMapOfAsciiStringAsciiString) -> None: pass @property def Width(self) -> int: """ :type: int """ @Width.setter def Width(self, arg0: int) -> None: pass pass class Image_VideoRecorder(OCP.Standard.Standard_Transient): """ Video recording tool based on FFmpeg framework.Video recording tool based on FFmpeg framework. """ def ChangeFrame(self) -> Image_PixMap: """ Access RGBA frame, should NOT be re-initialized outside. Note that image is expected to have upper-left origin. """ def Close(self) -> None: """ Close the stream - stop recorder. """ def DecrementRefCounter(self) -> int: """ Decrements the reference counter of this object; returns the decremented value """ def Delete(self) -> None: """ Memory deallocator for transient classes """ def DynamicType(self) -> OCP.Standard.Standard_Type: """ None """ def FrameCount(self) -> int: """ Return current frame index. """ def GetRefCount(self) -> int: """ Get the reference counter of this object """ def IncrementRefCounter(self) -> None: """ Increments the reference counter of this object """ @overload def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool: """ Returns a true value if this is an instance of Type. Returns a true value if this is an instance of TypeName. """ @overload def IsInstance(self,theTypeName : str) -> bool: ... @overload def IsKind(self,theTypeName : str) -> bool: """ Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. """ @overload def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ... def Open(self,theFileName : str,theParams : Image_VideoParams) -> bool: """ Open output stream - initialize recorder. """ def PushFrame(self) -> bool: """ Push new frame, should be called after Open(). """ def This(self) -> OCP.Standard.Standard_Transient: """ Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. """ def __init__(self) -> None: ... @staticmethod def get_type_descriptor_s() -> OCP.Standard.Standard_Type: """ None """ @staticmethod def get_type_name_s() -> str: """ None """ pass Image_CompressedFormat_NB = 24 Image_CompressedFormat_RGBA_S3TC_DXT1: OCP.Image.Image_CompressedFormat # value = Image_CompressedFormat_RGBA_S3TC_DXT3: OCP.Image.Image_CompressedFormat # value = Image_CompressedFormat_RGBA_S3TC_DXT5: OCP.Image.Image_CompressedFormat # value = Image_CompressedFormat_RGB_S3TC_DXT1: OCP.Image.Image_CompressedFormat # value = Image_CompressedFormat_UNKNOWN: OCP.Image.Image_CompressedFormat # value = Image_Format_Alpha: OCP.Image.Image_Format # value = Image_Format_AlphaF: OCP.Image.Image_Format # value = Image_Format_BGR: OCP.Image.Image_Format # value = Image_Format_BGR32: OCP.Image.Image_Format # value = Image_Format_BGRA: OCP.Image.Image_Format # value = Image_Format_BGRAF: OCP.Image.Image_Format # value = Image_Format_BGRF: OCP.Image.Image_Format # value = Image_Format_Gray: OCP.Image.Image_Format # value = Image_Format_Gray16: OCP.Image.Image_Format # value = Image_Format_GrayF: OCP.Image.Image_Format # value = Image_Format_GrayF_half: OCP.Image.Image_Format # value = Image_Format_NB = 20 Image_Format_RGB: OCP.Image.Image_Format # value = Image_Format_RGB32: OCP.Image.Image_Format # value = Image_Format_RGBA: OCP.Image.Image_Format # value = Image_Format_RGBAF: OCP.Image.Image_Format # value = Image_Format_RGBAF_half: OCP.Image.Image_Format # value = Image_Format_RGBF: OCP.Image.Image_Format # value = Image_Format_RGF: OCP.Image.Image_Format # value = Image_Format_RGF_half: OCP.Image.Image_Format # value = Image_Format_UNKNOWN: OCP.Image.Image_Format # value =