Effect.SamplePeriod Property (Microsoft.DirectX.DirectInput)

  • Article

The period at which the device should play back the effect, in microseconds. A value of 0 indicates that the default playback sample rate should be used. If the device is not capable of playing back the effect at the specified rate, it chooses the supported rate that is closest to the requested value.Setting a custom DwSamplePeriod can be used for special effects. For example, playing a sine wave at an artificially large sample period results in a rougher texture.

Definition

Visual Basic Public Property SamplePeriod As Integer
C# public int SamplePeriod { get; set; }
C++ public:
property int SamplePeriod {
        int get();
        void set(int value);
}
JScript public function get SamplePeriod() : int
public function set SamplePeriod(int);

Property Value

System.Int32

This property is read/write.