SoSFImage.StartEditing Method (SbVec2s, Int32, SoSFImage.DataTypes)

SoSFImageStartEditing Method (SbVec2s, Int32, SoSFImageDataTypes)

This method (along with OIV.Inventor.Fields.SoSFImage.FinishEditing()) can be used to efficiently edit the values in an image field.

Namespace: OIV.Inventor.Fields
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)

Syntax

C++

Copy

public SbNativeArray<byte> StartEditing(
	out SbVec2s size,
	out int nc,
	out SoSFImageDataTypes dataType
)

Public Function StartEditing ( 
	<OutAttribute> ByRef size As SbVec2s,
	<OutAttribute> ByRef nc As Integer,
	<OutAttribute> ByRef dataType As SoSFImageDataTypes
) As SbNativeArray(Of Byte)

public:
SbNativeArray<unsigned char>^ StartEditing(
	[OutAttribute] SbVec2s% size, 
	[OutAttribute] int% nc, 
	[OutAttribute] SoSFImageDataTypes% dataType
)

member StartEditing : 
        size : SbVec2s byref * 
        nc : int byref * 
        dataType : SoSFImageDataTypes byref -> SbNativeArray<byte>

Parameters

size: Type: OIV.InventorSbVec2s
nc: Type: SystemInt32
dataType: Type: OIV.Inventor.FieldsSoSFImageDataTypes

Return Value

Type: SbNativeArrayByte

Remarks

It returns the size of the image in the size and nc arguments; writing past the end of the array returned is a good way to cause hard-to-find core dumps.

Calling this method is the same as doing a call to setSubValues on the whole texture. The getSubTexture will return one more updated regions when called after finishEditing.

Reference

SoSFImage Class

StartEditing Overload

OIV.Inventor.Fields Namespace